Class: FireTimer
coresdk.workflow_activation.FireTimer
Notify a workflow that a timer has fired
Implements
Constructors
constructor
• new FireTimer(properties?): FireTimer
Constructs a new FireTimer.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFireTimer | Properties to set |
Returns
Properties
seq
• seq: number
Sequence number as provided by lang in the corresponding StartTimer command
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this FireTimer to JSON.
Returns
Object
JSON object
create
▸ create(properties?): FireTimer
Creates a new FireTimer instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFireTimer | Properties to set |
Returns
FireTimer instance
decode
▸ decode(reader, length?): FireTimer
Decodes a FireTimer 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
FireTimer
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): FireTimer
Decodes a FireTimer message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
FireTimer
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 FireTimer message. Does not implicitly coresdk.workflow_activation.FireTimer.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFireTimer | FireTimer message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified FireTimer message, length delimited. Does not implicitly coresdk.workflow_activation.FireTimer.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFireTimer | FireTimer message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): FireTimer
Creates a FireTimer message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
FireTimer
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for FireTimer
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 FireTimer message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | FireTimer | FireTimer |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object