Skip to main content

Class: EventGroupMarker

Represents an EventGroupMarker.

Properties​

inboundEvent?​

optional inboundEvent?: $Properties | null

EventGroupMarker inboundEvent.

inboundUpdate?​

optional inboundUpdate?: $Properties | null

EventGroupMarker inboundUpdate.

label?​

optional label?: $Properties | null

EventGroupMarker label.

variant?​

optional variant?: "label" | "inboundEvent" | "inboundUpdate"

What this Marker represents. The variant determines whether the Marker was created explicitly by user code (label) or implicitly by the SDK on inbound signals/events (inbound_event) or update handlers (inbound_update).

Methods​

toJSON()​

toJSON(): object

Converts this EventGroupMarker to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): EventGroupMarker & $Shape

Creates a new EventGroupMarker instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

EventGroupMarker & $Shape

EventGroupMarker instance

Call Signature​

static create(properties?): EventGroupMarker

Creates a new EventGroupMarker instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EventGroupMarker

EventGroupMarker instance

decode()​

static decode(reader, length?): EventGroupMarker & $Shape

Decodes an EventGroupMarker 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​

EventGroupMarker & $Shape

EventGroupMarker

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EventGroupMarker & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EventGroupMarker & $Shape

EventGroupMarker

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 EventGroupMarker message. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.verify|verify messages.

Parameters​

message​

$Properties

EventGroupMarker message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

EventGroupMarker message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EventGroupMarker

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

Parameters​

object​

Plain object

Returns​

EventGroupMarker

EventGroupMarker

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

EventGroupMarker

EventGroupMarker

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object