Class protos.google.cloud.dialogflow.cx.v3.QueryInput (2.13.0)

Represents a QueryInput.

Package

@google-cloud/dialogflow-cx!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3.IQueryInput);

Constructs a new QueryInput.

Parameter

Name	Description
properties	`IQueryInput` Properties to set

Properties

audio

public audio?: (google.cloud.dialogflow.cx.v3.IAudioInput|null);

QueryInput audio.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IAudioInput\|null)

dtmf

public dtmf?: (google.cloud.dialogflow.cx.v3.IDtmfInput|null);

QueryInput dtmf.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IDtmfInput\|null)

event

public event?: (google.cloud.dialogflow.cx.v3.IEventInput|null);

QueryInput event.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IEventInput\|null)

input

public input?: ("text"|"intent"|"audio"|"event"|"dtmf");

QueryInput input.

Property Value

Type	Description
("text"\|"intent"\|"audio"\|"event"\|"dtmf")

intent

public intent?: (google.cloud.dialogflow.cx.v3.IIntentInput|null);

QueryInput intent.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IIntentInput\|null)

languageCode

public languageCode: string;

QueryInput languageCode.

Property Value

Type	Description
string

text

public text?: (google.cloud.dialogflow.cx.v3.ITextInput|null);

QueryInput text.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.ITextInput\|null)

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.IQueryInput): google.cloud.dialogflow.cx.v3.QueryInput;

Creates a new QueryInput instance using the specified properties.

Parameter

Name	Description
properties	`IQueryInput` Properties to set

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryInput	QueryInput instance

decode(reader, length)

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

Decodes a QueryInput 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.v3.QueryInput	QueryInput

decodeDelimited(reader)

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

Decodes a QueryInput 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.v3.QueryInput	QueryInput

encode(message, writer)

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

Encodes the specified QueryInput message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IQueryInput` QueryInput 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.v3.QueryInput;

Creates a QueryInput 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.v3.QueryInput	QueryInput

toJSON()

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

Converts this QueryInput to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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