Class protos.google.cloud.dialogflow.cx.v3beta1.WebhookResponse (2.12.1)

Represents a WebhookResponse.

Package

@google-cloud/dialogflow-cx!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3beta1.IWebhookResponse);

Constructs a new WebhookResponse.

Parameter
Name Description
properties IWebhookResponse

Properties to set

Properties

fulfillmentResponse

public fulfillmentResponse?: (google.cloud.dialogflow.cx.v3beta1.WebhookResponse.IFulfillmentResponse|null);

WebhookResponse fulfillmentResponse.

Property Value
Type Description
(google.cloud.dialogflow.cx.v3beta1.WebhookResponse.IFulfillmentResponse|null)

pageInfo

public pageInfo?: (google.cloud.dialogflow.cx.v3beta1.IPageInfo|null);

WebhookResponse pageInfo.

Property Value
Type Description
(google.cloud.dialogflow.cx.v3beta1.IPageInfo|null)

payload

public payload?: (google.protobuf.IStruct|null);

WebhookResponse payload.

Property Value
Type Description
(google.protobuf.IStruct|null)

sessionInfo

public sessionInfo?: (google.cloud.dialogflow.cx.v3beta1.ISessionInfo|null);

WebhookResponse sessionInfo.

Property Value
Type Description
(google.cloud.dialogflow.cx.v3beta1.ISessionInfo|null)

targetFlow

public targetFlow?: (string|null);

WebhookResponse targetFlow.

Property Value
Type Description
(string|null)

targetPage

public targetPage?: (string|null);

WebhookResponse targetPage.

Property Value
Type Description
(string|null)

transition

public transition?: ("targetPage"|"targetFlow");

WebhookResponse transition.

Property Value
Type Description
("targetPage"|"targetFlow")

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.IWebhookResponse): google.cloud.dialogflow.cx.v3beta1.WebhookResponse;

Creates a new WebhookResponse instance using the specified properties.

Parameter
Name Description
properties IWebhookResponse

Properties to set
Returns
Type Description
google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3beta1.WebhookResponse;

Decodes a WebhookResponse message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3beta1.WebhookResponse;

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3beta1.IWebhookResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WebhookResponse message. Does not implicitly messages.

Parameters
Name Description
message IWebhookResponse

WebhookResponse message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dialogflow.cx.v3beta1.IWebhookResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WebhookResponse message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IWebhookResponse

WebhookResponse message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3beta1.WebhookResponse;

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

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse

toJSON()

public toJSON(): { [k: string]: any };

Converts this WebhookResponse to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3beta1.WebhookResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a WebhookResponse message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not