Class: Callback
Callback to attach to various events in the system, e.g. workflow run completion.
Properties
internal
• Optional internal: null | $Properties
Callback internal.
links
• links: $Properties[]
Links associated with the callback. It can be used to link to underlying resources of the callback.
nexus
• Optional nexus: null | $Properties
Callback nexus.
nexusHandler
• Optional nexusHandler: null | $Properties
Callback nexusHandler.
variant
• Optional variant: "nexus" | "internal" | "nexusHandler"
Callback variant.
Methods
toJSON
▸ toJSON(): Object
Converts this Callback to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Callback & $Shape
Creates a new Callback instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Callback instance
▸ create(properties?): Callback
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Callback & $Shape
Decodes a Callback 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
Callback
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Callback & $Shape
Decodes a Callback message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Callback
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 Callback message. Does not implicitly temporal.api.common.v1.Callback.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Callback message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Callback message, length delimited. Does not implicitly temporal.api.common.v1.Callback.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Callback message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Callback
Creates a Callback message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Callback
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Callback message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Callback | Callback |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object