Skip to main content

Class: CallbackInfo

CallbackInfo contains the state of an attached workflow callback.

Properties​

attempt​

attempt: number

The number of attempts made to deliver the callback. This number represents a minimum bound since the attempt is incremented after the callback request completes.

blockedReason​

blockedReason: string

If the state is BLOCKED, blocked reason provides additional information.

callback?​

optional callback?: $Properties | null

Information on how this callback should be invoked (e.g. its URL and type).

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

The time when the last attempt completed.

lastAttemptFailure?​

optional lastAttemptFailure?: $Properties | null

The last attempt's failure, if any.

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

The time when the next attempt is scheduled.

registrationTime?​

optional registrationTime?: $Properties | null

The time when the callback was registered.

requestId​

requestId: string

Server-generated request ID used as an idempotency token when invoking callbacks. It has no relation to caller-side request_id sent in operations like StartWorkflowExecutionRequest.

state​

state: CallbackState

CallbackInfo state.

trigger?​

optional trigger?: $Properties | null

Trigger for this callback.

Methods​

toJSON()​

toJSON(): object

Converts this CallbackInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CallbackInfo & $Shape

Creates a new CallbackInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

CallbackInfo & $Shape

CallbackInfo instance

Call Signature​

static create(properties?): CallbackInfo

Creates a new CallbackInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CallbackInfo

CallbackInfo instance

decode()​

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

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

CallbackInfo & $Shape

CallbackInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CallbackInfo & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CallbackInfo & $Shape

CallbackInfo

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

Parameters​

message​

$Properties

CallbackInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CallbackInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CallbackInfo

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

Parameters​

object​

Plain object

Returns​

CallbackInfo

CallbackInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CallbackInfo

CallbackInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object