Skip to main content

Class: TimerFiredEventAttributes

history.v1.TimerFiredEventAttributes

Represents a TimerFiredEventAttributes.

Properties

startedEventId

startedEventId: Long

The id of the TIMER_STARTED event itself


timerId

timerId: string

Will match the timer_id from TIMER_STARTED event for this timer

Methods

toJSON

toJSON(): Object

Converts this TimerFiredEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): TimerFiredEventAttributes & $Properties

Creates a new TimerFiredEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

TimerFiredEventAttributes & $Properties

TimerFiredEventAttributes instance

create(properties?): TimerFiredEventAttributes

Parameters

NameType
properties?$Properties

Returns

TimerFiredEventAttributes


decode

decode(reader, length?): TimerFiredEventAttributes & $Properties

Decodes a TimerFiredEventAttributes message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

TimerFiredEventAttributes & $Properties

TimerFiredEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): TimerFiredEventAttributes & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

TimerFiredEventAttributes & $Properties

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

NameTypeDescription
message$PropertiesTimerFiredEventAttributes message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
message$PropertiesTimerFiredEventAttributes message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

TimerFiredEventAttributes

TimerFiredEventAttributes


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageTimerFiredEventAttributesTimerFiredEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object