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