Skip to main content

Class: CallbackInfo

nexusoperation.v1.CallbackInfo

CallbackInfo contains the state of a callback attached to a standalone Nexus operation.

Properties​

info​

• Optional info: null | $Properties

Common callback info.


trigger​

• Optional trigger: null | $Properties

Trigger for this callback.

Methods​

toJSON​

▸ toJSON(): Object

Converts this CallbackInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): CallbackInfo & $Shape

Creates a new CallbackInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

CallbackInfo & $Shape

CallbackInfo instance

▸ create(properties?): CallbackInfo

Parameters​

NameType
properties?$Properties

Returns​

CallbackInfo


decode​

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

Decodes a CallbackInfo message from the specified reader or buffer.

Parameters​

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

▸ decodeDelimited(reader): CallbackInfo & $Shape

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

Parameters​

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

▸ encode(message, writer?): Writer

Encodes the specified CallbackInfo message. Does not implicitly temporal.api.nexusoperation.v1.CallbackInfo.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): CallbackInfo

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

CallbackInfo

CallbackInfo


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageCallbackInfoCallbackInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object