Class: TimerFiredEventAttributes
history.v1.TimerFiredEventAttributes
Represents a TimerFiredEventAttributes.
Implements
Constructors
constructor
• new TimerFiredEventAttributes(properties?): TimerFiredEventAttributes
Constructs a new TimerFiredEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITimerFiredEventAttributes | Properties to set |
Returns
Properties
startedEventId
• startedEventId: Long
The id of the TIMER_STARTED event itself
Implementation of
ITimerFiredEventAttributes.startedEventId
timerId
• timerId: string
Will match the timer_id from TIMER_STARTED event for this timer
Implementation of
ITimerFiredEventAttributes.timerId
Methods
toJSON
▸ toJSON(): Object
Converts this TimerFiredEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TimerFiredEventAttributes
Creates a new TimerFiredEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITimerFiredEventAttributes | Properties to set |
Returns
TimerFiredEventAttributes instance
decode
▸ decode(reader, length?): TimerFiredEventAttributes
Decodes a TimerFiredEventAttributes 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
TimerFiredEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TimerFiredEventAttributes
Decodes a TimerFiredEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TimerFiredEventAttributes
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 TimerFiredEventAttributes message. Does not implicitly temporal.api.history.v1.TimerFiredEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ITimerFiredEventAttributes | TimerFiredEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TimerFiredEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.TimerFiredEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ITimerFiredEventAttributes | TimerFiredEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TimerFiredEventAttributes
Creates a TimerFiredEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TimerFiredEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for TimerFiredEventAttributes
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 TimerFiredEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TimerFiredEventAttributes | TimerFiredEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object