Skip to main content

Class: OperationCompleted

v1.CallbackInfo.OperationCompleted

Trigger for when the Nexus operation is completed, covering both success cases as well as any type of failure.

Methods

toJSON

toJSON(): Object

Converts this OperationCompleted to JSON.

Returns

Object

JSON object


create

create(properties?): OperationCompleted & $Properties

Creates a new OperationCompleted instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

OperationCompleted & $Properties

OperationCompleted instance

create(properties?): OperationCompleted

Parameters

NameType
properties?$Properties

Returns

OperationCompleted


decode

decode(reader, length?): OperationCompleted & $Properties

Decodes an OperationCompleted message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

OperationCompleted & $Properties

OperationCompleted

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): OperationCompleted & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

OperationCompleted & $Properties

OperationCompleted

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): OperationCompleted

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

OperationCompleted

OperationCompleted


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageOperationCompletedOperationCompleted
options?IConversionOptionsConversion options

Returns

Object

Plain object