Skip to main content

Class: EventReference

EventReference is a direct reference to a history event through the event ID.

Properties​

eventId​

eventId: Long

EventReference eventId.

eventType​

eventType: EventType

EventReference eventType.

Methods​

toJSON()​

toJSON(): object

Converts this EventReference to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): EventReference & $Properties

Creates a new EventReference instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EventReference & $Properties

EventReference instance

Call Signature​

static create(properties?): EventReference

Creates a new EventReference instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EventReference

EventReference instance

decode()​

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

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

EventReference & $Properties

EventReference

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EventReference & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EventReference & $Properties

EventReference

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 EventReference message. Does not implicitly temporal.api.common.v1.Link.WorkflowEvent.EventReference.verify|verify messages.

Parameters​

message​

$Properties

EventReference message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified EventReference message, length delimited. Does not implicitly temporal.api.common.v1.Link.WorkflowEvent.EventReference.verify|verify messages.

Parameters​

message​

$Properties

EventReference message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EventReference

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

Parameters​

object​

Plain object

Returns​

EventReference

EventReference

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

EventReference

EventReference

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object