Skip to main content

Class: StartTimerCommandAttributes

Represents a StartTimerCommandAttributes.

Properties​

startToFireTimeout?​

optional startToFireTimeout?: $Properties | null

How long until the timer fires, producing a TIMER_FIRED event.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

timerId​

timerId: string

An id for the timer, currently live timers must have different ids. Typically autogenerated by the SDK.

Methods​

toJSON()​

toJSON(): object

Converts this StartTimerCommandAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartTimerCommandAttributes & $Properties

Creates a new StartTimerCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartTimerCommandAttributes & $Properties

StartTimerCommandAttributes instance

Call Signature​

static create(properties?): StartTimerCommandAttributes

Creates a new StartTimerCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartTimerCommandAttributes

StartTimerCommandAttributes instance

decode()​

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

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

StartTimerCommandAttributes & $Properties

StartTimerCommandAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartTimerCommandAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartTimerCommandAttributes & $Properties

StartTimerCommandAttributes

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

Parameters​

message​

$Properties

StartTimerCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StartTimerCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartTimerCommandAttributes

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

Parameters​

object​

Plain object

Returns​

StartTimerCommandAttributes

StartTimerCommandAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StartTimerCommandAttributes

StartTimerCommandAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object