JSDoc: Class: ExternalMessage

new ExternalMessage(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/server/integration/broker_pb.js, line 38

Extends

jspb.Message

Members

(static) displayName

Source:

proto/spine/server/integration/broker_pb.js, line 47

Methods

clearActorContext() → (non-null) {proto.spine.server.integration.ExternalMessage}

Clears the message field making it undefined.

Source:

proto/spine/server/integration/broker_pb.js, line 365

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

clearBoundedContextName() → (non-null) {proto.spine.server.integration.ExternalMessage}

Clears the message field making it undefined.

Source:

proto/spine/server/integration/broker_pb.js, line 402

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

clearId() → (non-null) {proto.spine.server.integration.ExternalMessage}

Clears the message field making it undefined.

Source:

proto/spine/server/integration/broker_pb.js, line 291

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

clearOriginalMessage() → (non-null) {proto.spine.server.integration.ExternalMessage}

Clears the message field making it undefined.

Source:

proto/spine/server/integration/broker_pb.js, line 328

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

getActorContext() → (nullable) {proto.spine.core.ActorContext}

optional spine.core.ActorContext actor_context = 3;

Source:

proto/spine/server/integration/broker_pb.js, line 346

Returns:

Type: proto.spine.core.ActorContext

getBoundedContextName() → (nullable) {proto.spine.core.BoundedContextName}

optional spine.core.BoundedContextName bounded_context_name = 4;

Source:

proto/spine/server/integration/broker_pb.js, line 383

Returns:

Type: proto.spine.core.BoundedContextName

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

optional google.protobuf.Any id = 1;

Source:

proto/spine/server/integration/broker_pb.js, line 272

Returns:

Type: proto.google.protobuf.Any

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

optional google.protobuf.Any original_message = 2;

Source:

proto/spine/server/integration/broker_pb.js, line 309

Returns:

Type: proto.google.protobuf.Any

hasActorContext() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/integration/broker_pb.js, line 374

Returns:

Type: boolean

hasBoundedContextName() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/integration/broker_pb.js, line 411

Returns:

Type: boolean

hasId() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/integration/broker_pb.js, line 300

Returns:

Type: boolean

hasOriginalMessage() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/integration/broker_pb.js, line 337

Returns:

Type: boolean

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

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

Source:

proto/spine/server/integration/broker_pb.js, line 217

Returns:

Type: Uint8Array

setActorContext(value) → (non-null) {proto.spine.server.integration.ExternalMessage}

Parameters:

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

Source:

proto/spine/server/integration/broker_pb.js, line 356

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

setBoundedContextName(value) → (non-null) {proto.spine.server.integration.ExternalMessage}

Parameters:

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

Source:

proto/spine/server/integration/broker_pb.js, line 393

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

setId(value) → (non-null) {proto.spine.server.integration.ExternalMessage}

Parameters:

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

Source:

proto/spine/server/integration/broker_pb.js, line 282

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

setOriginalMessage(value) → (non-null) {proto.spine.server.integration.ExternalMessage}

Parameters:

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

Source:

proto/spine/server/integration/broker_pb.js, line 319

Returns:

returns this

Type: proto.spine.server.integration.ExternalMessage

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/server/integration/broker_pb.js, line 128

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.server.integration.ExternalMessage}

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

proto/spine/server/integration/broker_pb.js, line 163

Returns:

Type: proto.spine.server.integration.ExternalMessage

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

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

Parameters:

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

Source:

proto/spine/server/integration/broker_pb.js, line 177

Returns:

Type: proto.spine.server.integration.ExternalMessage

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

Source:

proto/spine/server/integration/broker_pb.js, line 231

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

Source:

proto/spine/server/integration/broker_pb.js, line 142

Returns:

Type: Object