Class: StartTimer
coresdk.workflow_commands.StartTimer
Represents a StartTimer.
Implements
Constructors
constructor
• new StartTimer(properties?): StartTimer
Constructs a new StartTimer.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartTimer | Properties to set |
Returns
Properties
seq
• seq: number
Lang's incremental sequence number, used as the operation identifier
Implementation of
startToFireTimeout
• Optional startToFireTimeout: null | IDuration
StartTimer startToFireTimeout.
Implementation of
IStartTimer.startToFireTimeout
Methods
toJSON
▸ toJSON(): Object
Converts this StartTimer to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartTimer
Creates a new StartTimer instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartTimer | Properties to set |
Returns
StartTimer instance
decode
▸ decode(reader, length?): StartTimer
Decodes a StartTimer 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
StartTimer
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartTimer
Decodes a StartTimer message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartTimer
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 StartTimer message. Does not implicitly coresdk.workflow_commands.StartTimer.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartTimer | StartTimer message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartTimer message, length delimited. Does not implicitly coresdk.workflow_commands.StartTimer.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartTimer | StartTimer message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartTimer
Creates a StartTimer message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartTimer
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for StartTimer
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 StartTimer message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartTimer | StartTimer |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object