Class: Success

Success(opt_dataopt)

new Success(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:

Extends

  • jspb.Message

Members

(static) ExhaustCase :number

Type:
  • number
Properties:
Name Type Description
EXHAUST_NOT_SET number
PRODUCED_EVENTS number
PRODUCED_COMMANDS number
REJECTION number
Source:

(static) displayName

Source:

Methods

clearProducedCommands() → (non-null) {proto.spine.server.dispatch.Success}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.server.dispatch.Success

clearProducedEvents() → (non-null) {proto.spine.server.dispatch.Success}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.server.dispatch.Success

clearRejection() → (non-null) {proto.spine.server.dispatch.Success}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.server.dispatch.Success

getExhaustCase() → {proto.spine.server.dispatch.Success.ExhaustCase}

Source:
Returns:
Type
proto.spine.server.dispatch.Success.ExhaustCase

getProducedCommands() → (nullable) {proto.spine.server.dispatch.ProducedCommands}

optional ProducedCommands produced_commands = 2;
Source:
Returns:
Type
proto.spine.server.dispatch.ProducedCommands

getProducedEvents() → (nullable) {proto.spine.server.dispatch.ProducedEvents}

optional ProducedEvents produced_events = 1;
Source:
Returns:
Type
proto.spine.server.dispatch.ProducedEvents

getRejection() → (nullable) {proto.spine.core.Event}

optional spine.core.Event rejection = 3;
Source:
Returns:
Type
proto.spine.core.Event

hasProducedCommands() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasProducedEvents() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasRejection() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

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

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setProducedCommands(value) → (non-null) {proto.spine.server.dispatch.Success}

Parameters:
Name Type Description
value proto.spine.server.dispatch.ProducedCommands | undefined
Source:
Returns:
returns this
Type
proto.spine.server.dispatch.Success

setProducedEvents(value) → (non-null) {proto.spine.server.dispatch.Success}

Parameters:
Name Type Description
value proto.spine.server.dispatch.ProducedEvents | undefined
Source:
Returns:
returns this
Type
proto.spine.server.dispatch.Success

setRejection(value) → (non-null) {proto.spine.server.dispatch.Success}

Parameters:
Name Type Description
value proto.spine.core.Event | undefined
Source:
Returns:
returns this
Type
proto.spine.server.dispatch.Success

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:
Returns:
Type
Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.server.dispatch.Success}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.spine.server.dispatch.Success

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

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.spine.server.dispatch.Success The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.spine.server.dispatch.Success

(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.server.dispatch.Success
writer jspb.BinaryWriter
Source:

(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.server.dispatch.Success The msg instance to transform.
Source:
Returns:
Type
Object