Skip to main content

Class: CancelTimer

coresdk.workflow_commands.CancelTimer

Represents a CancelTimer.

Implements#

Constructors#

constructor#

new CancelTimer(properties?)

Constructs a new CancelTimer.

Parameters#

NameType
properties?ICancelTimer

Properties#

seq#

seq: number

Lang's incremental sequence number as passed to StartTimer

Implementation of#

ICancelTimer.seq

Methods#

toJSON#

toJSON(): Object

Converts this CancelTimer to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CancelTimer

Decodes a CancelTimer message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

CancelTimer

CancelTimer


decodeDelimited#

Static decodeDelimited(reader): CancelTimer

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

CancelTimer

CancelTimer


encode#

Static encode(message, writer?): Writer

Encodes the specified CancelTimer message. Does not implicitly {@link coresdk.workflow_commands.CancelTimer.verify|verify} messages.

Parameters#

NameTypeDescription
messageICancelTimerCancelTimer message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified CancelTimer message, length delimited. Does not implicitly {@link coresdk.workflow_commands.CancelTimer.verify|verify} messages.

Parameters#

NameTypeDescription
messageICancelTimerCancelTimer message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): CancelTimer

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

CancelTimer

CancelTimer


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCancelTimerCancelTimer
options?IConversionOptions-

Returns#

Object

Plain object