Skip to main content

Class: CancelTimerCommandAttributes

Represents a CancelTimerCommandAttributes.

Properties​

timerId​

timerId: string

The same timer id from the start timer command

Methods​

toJSON()​

toJSON(): object

Converts this CancelTimerCommandAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelTimerCommandAttributes & $Properties

Creates a new CancelTimerCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelTimerCommandAttributes & $Properties

CancelTimerCommandAttributes instance

Call Signature​

static create(properties?): CancelTimerCommandAttributes

Creates a new CancelTimerCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelTimerCommandAttributes

CancelTimerCommandAttributes instance

decode()​

static decode(reader, length?): CancelTimerCommandAttributes & $Properties

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

CancelTimerCommandAttributes & $Properties

CancelTimerCommandAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelTimerCommandAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelTimerCommandAttributes & $Properties

CancelTimerCommandAttributes

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

Parameters​

message​

$Properties

CancelTimerCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CancelTimerCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CancelTimerCommandAttributes

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

Parameters​

object​

Plain object

Returns​

CancelTimerCommandAttributes

CancelTimerCommandAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CancelTimerCommandAttributes

CancelTimerCommandAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object