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