JSDoc: Class: EntityRestored

new EntityRestored(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 242

Extends

jspb.Message

Members

(static) displayName

Source:

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

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 3539

Returns:

Type: proto.spine.core.MessageId

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

Clears the message field making it undefined.

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

clearState() → (non-null) {proto.spine.system.server.EntityRestored}

Clears the message field making it undefined.

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

Clears the message field making it undefined.

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

Clears the message field making it undefined.

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

optional spine.core.MessageId entity = 1;

Source:

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

Returns:

Type: proto.spine.core.MessageId

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 3519

Returns:

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

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

optional google.protobuf.Any state = 5;

Source:

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

Returns:

Type: proto.google.protobuf.Any

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

optional spine.core.Version version = 4;

Source:

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

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 3557

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 3510

Returns:

Type: boolean

hasState() → {boolean}

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasVersion() → {boolean}

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasWhen() → {boolean}

Returns whether this field is set.

Source:

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

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 3419

Returns:

Type: Uint8Array

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

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

setState(value) → (non-null) {proto.spine.system.server.EntityRestored}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.spine.system.server.EntityRestored

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 3323

Returns:

Type: Object

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

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 3360

Returns:

Type: proto.spine.system.server.EntityRestored

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

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.EntityRestored	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

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

Returns:

Type: proto.spine.system.server.EntityRestored

(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.EntityRestored
`writer`	jspb.BinaryWriter

Source:

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

(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.EntityRestored	The msg instance to transform.

Source:

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

Returns:

Type: Object