Skip to main content

Class: Callback

Callback to attach to various events in the system, e.g. workflow run completion.

Properties​

internal?​

optional internal?: $Properties | null

Callback internal.

links: $Properties[]

Links associated with the callback. It can be used to link to underlying resources of the callback.

nexus?​

optional nexus?: $Properties | null

Callback nexus.

nexusHandler?​

optional nexusHandler?: $Properties | null

Callback nexusHandler.

variant?​

optional variant?: "nexus" | "internal" | "nexusHandler"

Callback variant.

Methods​

toJSON()​

toJSON(): object

Converts this Callback to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Callback & $Shape

Creates a new Callback instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Callback & $Shape

Callback instance

Call Signature​

static create(properties?): Callback

Creates a new Callback instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Callback

Callback instance

decode()​

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

Decodes a Callback 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​

Callback & $Shape

Callback

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Callback & $Shape

Decodes a Callback message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Callback & $Shape

Callback

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

Parameters​

message​

$Properties

Callback message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Callback message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Callback

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Callback

Callback

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Callback

Callback

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object