Skip to main content

Class: StartTimer

coresdk.workflow_commands.StartTimer

Represents a StartTimer.

Implements#

Constructors#

constructor#

new StartTimer(properties?)

Constructs a new StartTimer.

Parameters#

NameType
properties?IStartTimer

Properties#

seq#

seq: number

Lang's incremental sequence number, used as the operation identifier

Implementation of#

IStartTimer.seq


startToFireTimeout#

Optional startToFireTimeout: null | IDuration

StartTimer startToFireTimeout.

Implementation of#

IStartTimer.startToFireTimeout

Methods#

toJSON#

toJSON(): Object

Converts this StartTimer to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): StartTimer

Decodes a StartTimer message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

StartTimer

StartTimer


decodeDelimited#

Static decodeDelimited(reader): StartTimer

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

StartTimer

StartTimer


encode#

Static encode(message, writer?): Writer

Encodes the specified StartTimer message. Does not implicitly {@link coresdk.workflow_commands.StartTimer.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStartTimerStartTimer message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified StartTimer message, length delimited. Does not implicitly {@link coresdk.workflow_commands.StartTimer.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStartTimerStartTimer message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): StartTimer

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

StartTimer

StartTimer


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageStartTimerStartTimer
options?IConversionOptions-

Returns#

Object

Plain object