Class protos.google.cloud.dialogflow.cx.v3beta1.WebhookRequest (3.2.1)

Represents a WebhookRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new WebhookRequest.

Parameter

Name	Description
`properties`	`IWebhookRequest` Properties to set

Properties

detectIntentResponseId

public detectIntentResponseId: string;

WebhookRequest detectIntentResponseId.

fulfillmentInfo

public fulfillmentInfo?: (google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IFulfillmentInfo|null);

WebhookRequest fulfillmentInfo.

intentInfo

public intentInfo?: (google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IIntentInfo|null);

WebhookRequest intentInfo.

languageCode

public languageCode: string;

WebhookRequest languageCode.

messages

public messages: google.cloud.dialogflow.cx.v3beta1.IResponseMessage[];

WebhookRequest messages.

pageInfo

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

WebhookRequest pageInfo.

payload

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

WebhookRequest payload.

query

public query?: ("text"|"triggerIntent"|"transcript"|"triggerEvent");

WebhookRequest query.

sentimentAnalysisResult

public sentimentAnalysisResult?: (google.cloud.dialogflow.cx.v3beta1.WebhookRequest.ISentimentAnalysisResult|null);

WebhookRequest sentimentAnalysisResult.

sessionInfo

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

WebhookRequest sessionInfo.

text

public text?: (string|null);

WebhookRequest text.

transcript

public transcript?: (string|null);

WebhookRequest transcript.

triggerEvent

public triggerEvent?: (string|null);

WebhookRequest triggerEvent.

triggerIntent

public triggerIntent?: (string|null);

WebhookRequest triggerIntent.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.IWebhookRequest): google.cloud.dialogflow.cx.v3beta1.WebhookRequest;

Creates a new WebhookRequest instance using the specified properties.

Parameter

Name	Description
`properties`	`IWebhookRequest` Properties to set

Returns

Type	Description
`google.cloud.dialogflow.cx.v3beta1.WebhookRequest`	WebhookRequest instance

decode(reader, length)

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

Decodes a WebhookRequest 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.WebhookRequest`	WebhookRequest

decodeDelimited(reader)

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

Decodes a WebhookRequest 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.WebhookRequest`	WebhookRequest

encode(message, writer)

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

Encodes the specified WebhookRequest message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IWebhookRequest` WebhookRequest 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.IWebhookRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IWebhookRequest` WebhookRequest 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.WebhookRequest;

Creates a WebhookRequest 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.WebhookRequest`	WebhookRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for WebhookRequest

Parameter

Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
`string`	The default type url

toJSON()

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

Converts this WebhookRequest to JSON.

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
`message`	`google.cloud.dialogflow.cx.v3beta1.WebhookRequest` WebhookRequest
`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 WebhookRequest 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