Class: Response
A response indicating that the handler has successfully processed a request.
Properties
cancelOperation
• Optional cancelOperation: null | $Properties
Response cancelOperation.
startOperation
• Optional startOperation: null | $Properties
Response startOperation.
variant
• Optional variant: "startOperation" | "cancelOperation"
Variant must correlate to the corresponding Request's variant.
Methods
toJSON
▸ toJSON(): Object
Converts this Response to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Response & $Shape
Creates a new Response instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Response instance
▸ create(properties?): Response
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Response & $Shape
Decodes a Response 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
Response
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Response & $Shape
Decodes a Response message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Response
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 Response message. Does not implicitly temporal.api.nexus.v1.Response.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Response message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Response message, length delimited. Does not implicitly temporal.api.nexus.v1.Response.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Response message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Response
Creates a Response message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Response
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Response message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Response | Response |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object