JSDoc: Class: EntityArchived

new EntityArchived(opt_dataopt)

Generated by JsPbCodeGenerator.

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 179

Extends

jspb.Message

Members

(static) displayName

Source:

proto/spine/system/server/entity_log_events_pb.js, line 188

Methods

addSignalId(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.spine.core.MessageId}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.spine.core.MessageId	<optional>
`opt_index`	number	<optional>

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2325

Returns:

Type: proto.spine.core.MessageId

clearEntity() → (non-null) {proto.spine.system.server.EntityArchived}

Clears the message field making it undefined.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2287

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

clearLastState() → (non-null) {proto.spine.system.server.EntityArchived}

Clears the message field making it undefined.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2436

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

clearSignalIdList() → (non-null) {proto.spine.system.server.EntityArchived}

Clears the list making it empty but non-null.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2334

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

clearVersion() → (non-null) {proto.spine.system.server.EntityArchived}

Clears the message field making it undefined.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2399

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

clearWhen() → (non-null) {proto.spine.system.server.EntityArchived}

Clears the message field making it undefined.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2362

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

getEntity() → (nullable) {proto.spine.core.MessageId}

optional spine.core.MessageId entity = 1;

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2268

Returns:

Type: proto.spine.core.MessageId

getLastState() → (nullable) {proto.google.protobuf.Any}

optional google.protobuf.Any last_state = 5;

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2417

Returns:

Type: proto.google.protobuf.Any

getSignalIdList() → (non-null) {Array.<!proto.spine.core.MessageId>}

repeated spine.core.MessageId signal_id = 2;

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2305

Returns:

Type: Array.<!proto.spine.core.MessageId>

getVersion() → (nullable) {proto.spine.core.Version}

optional spine.core.Version version = 4;

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2380

Returns:

Type: proto.spine.core.Version

getWhen() → (nullable) {proto.google.protobuf.Timestamp}

optional google.protobuf.Timestamp when = 3;

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2343

Returns:

Type: proto.google.protobuf.Timestamp

hasEntity() → {boolean}

Returns whether this field is set.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2296

Returns:

Type: boolean

hasLastState() → {boolean}

Returns whether this field is set.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2445

Returns:

Type: boolean

hasVersion() → {boolean}

Returns whether this field is set.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2408

Returns:

Type: boolean

hasWhen() → {boolean}

Returns whether this field is set.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2371

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2205

Returns:

Type: Uint8Array

setEntity(value) → (non-null) {proto.spine.system.server.EntityArchived}

Parameters:

Name	Type	Description
`value`	proto.spine.core.MessageId \| undefined

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2278

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

setLastState(value) → (non-null) {proto.spine.system.server.EntityArchived}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Any \| undefined

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2427

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

setSignalIdList(valuenon-null) → (non-null) {proto.spine.system.server.EntityArchived}

Parameters:

Name	Type	Description
`value`	Array.<!proto.spine.core.MessageId>

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2315

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

setVersion(value) → (non-null) {proto.spine.system.server.EntityArchived}

Parameters:

Name	Type	Description
`value`	proto.spine.core.Version \| undefined

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2390

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

setWhen(value) → (non-null) {proto.spine.system.server.EntityArchived}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Timestamp \| undefined

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2353

Returns:

returns this

Type: proto.spine.system.server.EntityArchived

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2109

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.system.server.EntityArchived}

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2146

Returns:

Type: proto.spine.system.server.EntityArchived

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.spine.system.server.EntityArchived}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.spine.system.server.EntityArchived	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2160

Returns:

Type: proto.spine.system.server.EntityArchived

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Parameters:

Name	Type	Description
`message`	proto.spine.system.server.EntityArchived
`writer`	jspb.BinaryWriter

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2219

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.spine.system.server.EntityArchived	The msg instance to transform.

Source:

proto/spine/system/server/entity_log_events_pb.js, line 2123

Returns:

Type: Object