Skip to main content

Class: CancelTimer

coresdk.workflow_commands.CancelTimer

Represents a CancelTimer.

Implements

Constructors

constructor

new CancelTimer(properties?): CancelTimer

Constructs a new CancelTimer.

Parameters

NameTypeDescription
properties?ICancelTimerProperties to set

Returns

CancelTimer

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


create

create(properties?): CancelTimer

Creates a new CancelTimer instance using the specified properties.

Parameters

NameTypeDescription
properties?ICancelTimerProperties to set

Returns

CancelTimer

CancelTimer instance


decode

decode(reader, length?): CancelTimer

Decodes a CancelTimer message from the specified reader or buffer.

Parameters

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

Returns

CancelTimer

CancelTimer

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): CancelTimer

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CancelTimer

CancelTimer

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 CancelTimer message. Does not implicitly coresdk.workflow_commands.CancelTimer.verify|verify messages.

Parameters

NameTypeDescription
messageICancelTimerCancelTimer message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageICancelTimerCancelTimer message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CancelTimer

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCancelTimerCancelTimer
options?IConversionOptionsConversion options

Returns

Object

Plain object