new DispatchOutcome(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. |
Extends
- jspb.Message
Members
(static) ResultCase :number
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
RESULT_NOT_SET |
number | |
SUCCESS |
number | |
ERROR |
number | |
INTERRUPTED |
number | |
IGNORED |
number | |
SENT_TO_INBOX |
number | |
PUBLISHED_TO_REMOTE |
number | |
NO_TARGETS_TO_ROUTE |
number |
(static) displayName
Methods
clearError() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the message field making it undefined.
Returns:
returns this
clearIgnored() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the message field making it undefined.
Returns:
returns this
clearInterrupted() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the message field making it undefined.
Returns:
returns this
clearNoTargetsToRoute() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the field making it undefined.
Returns:
returns this
clearPropagatedSignal() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the message field making it undefined.
Returns:
returns this
clearPublishedToRemote() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the field making it undefined.
Returns:
returns this
clearSentToInbox() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the message field making it undefined.
Returns:
returns this
clearSuccess() → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Clears the message field making it undefined.
Returns:
returns this
getError() → (nullable) {proto.spine.base.Error}
optional spine.base.Error error = 3;
Returns:
getIgnored() → (nullable) {proto.spine.server.dispatch.Ignore}
optional Ignore ignored = 5;
Returns:
getInterrupted() → (nullable) {proto.spine.server.dispatch.Interruption}
optional Interruption interrupted = 4;
Returns:
getNoTargetsToRoute() → {boolean}
optional bool no_targets_to_route = 8;
Returns:
- Type
- boolean
getPropagatedSignal() → (nullable) {proto.spine.core.MessageId}
optional spine.core.MessageId propagated_signal = 1;
Returns:
getPublishedToRemote() → {boolean}
optional bool published_to_remote = 7;
Returns:
- Type
- boolean
getResultCase() → {proto.spine.server.dispatch.DispatchOutcome.ResultCase}
Returns:
getSentToInbox() → (nullable) {proto.spine.server.dispatch.InboxAddresses}
optional InboxAddresses sent_to_inbox = 6;
Returns:
getSuccess() → (nullable) {proto.spine.server.dispatch.Success}
optional Success success = 2;
Returns:
hasError() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasIgnored() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasInterrupted() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasNoTargetsToRoute() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPropagatedSignal() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasPublishedToRemote() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasSentToInbox() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasSuccess() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
serializeBinary() → (non-null) {Uint8Array}
Serializes the message to binary data (in protobuf wire format).
Returns:
- Type
- Uint8Array
setError(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.base.Error | undefined |
Returns:
returns this
setIgnored(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.dispatch.Ignore | undefined |
Returns:
returns this
setInterrupted(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.dispatch.Interruption | undefined |
Returns:
returns this
setNoTargetsToRoute(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setPropagatedSignal(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.core.MessageId | undefined |
Returns:
returns this
setPublishedToRemote(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setSentToInbox(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.dispatch.InboxAddresses | undefined |
Returns:
returns this
setSuccess(value) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.dispatch.Success | undefined |
Returns:
returns this
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 |
Returns:
- Type
- Object
(static) deserializeBinary(bytes) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
Deserializes binary data (in protobuf wire format).
Parameters:
| Name | Type | Description |
|---|---|---|
bytes |
jspb.ByteSource | The bytes to deserialize. |
Returns:
(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.spine.server.dispatch.DispatchOutcome}
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.DispatchOutcome | The message object to deserialize into. |
reader |
jspb.BinaryReader | The BinaryReader to use. |
Returns:
(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.DispatchOutcome | |
writer |
jspb.BinaryWriter |
(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.DispatchOutcome | The msg instance to transform. |
Returns:
- Type
- Object