Skip to main content

Class: InboundEvent

The event ID of an event in the present workflow that triggered implicit creation of this group Marker.

The target event's type must be one of the following:

  • WORKFLOW_EXECUTION_STARTED
  • WORKFLOW_EXECUTION_SIGNALED

Properties​

inboundEventId​

inboundEventId: Long

InboundEvent inboundEventId.

Methods​

toJSON()​

toJSON(): object

Converts this InboundEvent to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): InboundEvent & $Properties

Creates a new InboundEvent instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

InboundEvent & $Properties

InboundEvent instance

Call Signature​

static create(properties?): InboundEvent

Creates a new InboundEvent instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

InboundEvent

InboundEvent instance

decode()​

static decode(reader, length?): InboundEvent & $Properties

Decodes an InboundEvent message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

InboundEvent & $Properties

InboundEvent

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): InboundEvent & $Properties

Decodes an InboundEvent message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

InboundEvent & $Properties

InboundEvent

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified InboundEvent message. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundEvent.verify|verify messages.

Parameters​

message​

$Properties

InboundEvent message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified InboundEvent message, length delimited. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundEvent.verify|verify messages.

Parameters​

message​

$Properties

InboundEvent message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): InboundEvent

Creates an InboundEvent message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

InboundEvent

InboundEvent

toObject()​

static toObject(message, options?): object

Creates a plain object from an InboundEvent message. Also converts values to other types if specified.

Parameters​

message​

InboundEvent

InboundEvent

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object