Skip to main content

Class: CancelTimerCommandAttributes

command.v1.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

create(properties?): CancelTimerCommandAttributes & $Properties

Creates a new CancelTimerCommandAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

CancelTimerCommandAttributes & $Properties

CancelTimerCommandAttributes instance

create(properties?): CancelTimerCommandAttributes

Parameters

NameType
properties?$Properties

Returns

CancelTimerCommandAttributes


decode

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

Decodes a CancelTimerCommandAttributes message from the specified reader or buffer.

Parameters

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

decodeDelimited(reader): CancelTimerCommandAttributes & $Properties

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

Parameters

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

encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): CancelTimerCommandAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

CancelTimerCommandAttributes

CancelTimerCommandAttributes


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCancelTimerCommandAttributesCancelTimerCommandAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object