Class: EventGroupMarker
Represents an EventGroupMarker.
Implements
Constructors
constructor
• new EventGroupMarker(properties?): EventGroupMarker
Constructs a new EventGroupMarker.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEventGroupMarker | Properties to set |
Returns
Properties
inboundEvent
• Optional inboundEvent: null | IInboundEvent
EventGroupMarker inboundEvent.
Implementation of
IEventGroupMarker.inboundEvent
inboundUpdate
• Optional inboundUpdate: null | IInboundUpdate
EventGroupMarker inboundUpdate.
Implementation of
IEventGroupMarker.inboundUpdate
label
• Optional label: null | ILabel
EventGroupMarker label.
Implementation of
variant
• Optional variant: "label" | "inboundEvent" | "inboundUpdate"
What this Marker represents. The variant determines whether the Marker was created explicitly by user code (label) or implicitly by the SDK on inbound signals/events (inbound_event) or update handlers (inbound_update).
Methods
toJSON
▸ toJSON(): Object
Converts this EventGroupMarker to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EventGroupMarker
Creates a new EventGroupMarker instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEventGroupMarker | Properties to set |
Returns
EventGroupMarker instance
decode
▸ decode(reader, length?): EventGroupMarker
Decodes an EventGroupMarker 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
EventGroupMarker
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): EventGroupMarker
Decodes an EventGroupMarker message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
EventGroupMarker
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 EventGroupMarker message. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEventGroupMarker | EventGroupMarker message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified EventGroupMarker message, length delimited. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEventGroupMarker | EventGroupMarker message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): EventGroupMarker
Creates an EventGroupMarker message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EventGroupMarker
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for EventGroupMarker
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 an EventGroupMarker message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | EventGroupMarker | EventGroupMarker |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object