new InboxMessage(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) PayloadCase :number
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
PAYLOAD_NOT_SET |
number | |
EVENT |
number | |
COMMAND |
number |
(static) displayName
Methods
clearCommand() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
clearEvent() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
clearId() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
clearInboxId() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
clearKeepUntil() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
clearSignalId() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
clearWhenReceived() → (non-null) {proto.spine.server.delivery.InboxMessage}
Clears the message field making it undefined.
Returns:
returns this
getCommand() → (nullable) {proto.spine.core.Command}
optional spine.core.Command command = 6;
Returns:
getEvent() → (nullable) {proto.spine.core.Event}
optional spine.core.Event event = 5;
Returns:
getId() → (nullable) {proto.spine.server.delivery.InboxMessageId}
optional InboxMessageId id = 1;
Returns:
getInboxId() → (nullable) {proto.spine.server.delivery.InboxId}
optional InboxId inbox_id = 3;
Returns:
getKeepUntil() → (nullable) {proto.google.protobuf.Timestamp}
optional google.protobuf.Timestamp keep_until = 11;
Returns:
getLabel() → (non-null) {proto.spine.server.delivery.InboxLabel}
optional InboxLabel label = 7;
Returns:
getPayloadCase() → {proto.spine.server.delivery.InboxMessage.PayloadCase}
Returns:
getSignalId() → (nullable) {proto.spine.server.delivery.InboxSignalId}
optional InboxSignalId signal_id = 2;
Returns:
getStatus() → (non-null) {proto.spine.server.delivery.InboxMessageStatus}
optional InboxMessageStatus status = 8;
Returns:
getVersion() → {number}
optional int32 version = 10;
Returns:
- Type
- number
getWhenReceived() → (nullable) {proto.google.protobuf.Timestamp}
optional google.protobuf.Timestamp when_received = 9;
Returns:
hasCommand() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasEvent() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasId() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasInboxId() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasKeepUntil() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasSignalId() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasWhenReceived() → {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
setCommand(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.core.Command | undefined |
Returns:
returns this
setEvent(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.core.Event | undefined |
Returns:
returns this
setId(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.delivery.InboxMessageId | undefined |
Returns:
returns this
setInboxId(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.delivery.InboxId | undefined |
Returns:
returns this
setKeepUntil(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.Timestamp | undefined |
Returns:
returns this
setLabel(valuenon-null) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.delivery.InboxLabel |
Returns:
returns this
setSignalId(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.delivery.InboxSignalId | undefined |
Returns:
returns this
setStatus(valuenon-null) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.spine.server.delivery.InboxMessageStatus |
Returns:
returns this
setVersion(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number |
Returns:
returns this
setWhenReceived(value) → (non-null) {proto.spine.server.delivery.InboxMessage}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.Timestamp | 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.delivery.InboxMessage}
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.delivery.InboxMessage}
Deserializes binary data (in protobuf wire format) from the
given reader into the given message object.
Parameters:
| Name | Type | Description |
|---|---|---|
msg |
proto.spine.server.delivery.InboxMessage | 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.delivery.InboxMessage | |
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.delivery.InboxMessage | The msg instance to transform. |
Returns:
- Type
- Object