Skip to main content

Class: EventGroupMarker

sdk.v1.EventGroupMarker

Represents an EventGroupMarker.

Properties​

inboundEvent​

• Optional inboundEvent: null | $Properties

EventGroupMarker inboundEvent.


inboundUpdate​

• Optional inboundUpdate: null | $Properties

EventGroupMarker inboundUpdate.


label​

• Optional label: null | $Properties

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​

▸ create(properties?): EventGroupMarker & $Shape

Creates a new EventGroupMarker instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

EventGroupMarker & $Shape

EventGroupMarker instance

▸ create(properties?): EventGroupMarker

Parameters​

NameType
properties?$Properties

Returns​

EventGroupMarker


decode​

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

Decodes an EventGroupMarker message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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​

▸ decodeDelimited(reader): EventGroupMarker & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader 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​

▸ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesEventGroupMarker message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesEventGroupMarker message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): EventGroupMarker

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

EventGroupMarker

EventGroupMarker


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageEventGroupMarkerEventGroupMarker
options?IConversionOptionsConversion options

Returns​

Object

Plain object