Skip to main content

Class: Response

A response indicating that the handler has successfully processed a request.

Properties​

cancelOperation?​

optional cancelOperation?: $Properties | null

Response cancelOperation.

startOperation?​

optional startOperation?: $Properties | null

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()​

Call Signature​

static create(properties?): Response & $Shape

Creates a new Response instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Response & $Shape

Response instance

Call Signature​

static create(properties?): Response

Creates a new Response instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Response

Response instance

decode()​

static decode(reader, length?): Response & $Shape

Decodes a Response message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Response & $Shape

Response

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Response & $Shape

Decodes a Response message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Response & $Shape

Response

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Response message. Does not implicitly temporal.api.nexus.v1.Response.verify|verify messages.

Parameters​

message​

$Properties

Response message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Response message, length delimited. Does not implicitly temporal.api.nexus.v1.Response.verify|verify messages.

Parameters​

message​

$Properties

Response message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Response

Creates a Response message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

Response

Response

toObject()​

static toObject(message, options?): object

Creates a plain object from a Response message. Also converts values to other types if specified.

Parameters​

message​

Response

Response

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object