Class: StartTimerCommandAttributes

command.v1.StartTimerCommandAttributes

Represents a StartTimerCommandAttributes.

Implements

• IStartTimerCommandAttributes

Constructors

constructor

• new StartTimerCommandAttributes(properties?): StartTimerCommandAttributes

Constructs a new StartTimerCommandAttributes.

Parameters

Name	Type	Description
properties?	IStartTimerCommandAttributes	Properties to set

Returns

StartTimerCommandAttributes

Properties

startToFireTimeout

• Optional startToFireTimeout: null | IDuration

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. --)

Implementation of

IStartTimerCommandAttributes.startToFireTimeout

---

timerId

• timerId: string

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

Implementation of

IStartTimerCommandAttributes.timerId

Methods

toJSON

▸ toJSON(): Object

Converts this StartTimerCommandAttributes to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartTimerCommandAttributes

Creates a new StartTimerCommandAttributes instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStartTimerCommandAttributes	Properties to set

Returns

StartTimerCommandAttributes

StartTimerCommandAttributes instance

---

decode

▸ decode(reader, length?): StartTimerCommandAttributes

Decodes a StartTimerCommandAttributes message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

StartTimerCommandAttributes

StartTimerCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartTimerCommandAttributes

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

StartTimerCommandAttributes

StartTimerCommandAttributes

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

Parameters

Name	Type	Description
message	IStartTimerCommandAttributes	StartTimerCommandAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartTimerCommandAttributes	StartTimerCommandAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartTimerCommandAttributes

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartTimerCommandAttributes

StartTimerCommandAttributes

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartTimerCommandAttributes

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartTimerCommandAttributes	StartTimerCommandAttributes
options?	IConversionOptions	Conversion options

Returns

Object

Plain object