Represents an Agent.
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dialogflow.cx.v3.IAgent);
Constructs a new Agent.
Parameter | |
---|---|
Name | Description |
properties |
IAgent
Properties to set |
Properties
advancedSettings
public advancedSettings?: (google.cloud.dialogflow.cx.v3.IAdvancedSettings|null);
Agent advancedSettings.
avatarUri
public avatarUri: string;
Agent avatarUri.
defaultLanguageCode
public defaultLanguageCode: string;
Agent defaultLanguageCode.
description
public description: string;
Agent description.
displayName
public displayName: string;
Agent displayName.
enableSpellCorrection
public enableSpellCorrection: boolean;
Agent enableSpellCorrection.
enableStackdriverLogging
public enableStackdriverLogging: boolean;
Agent enableStackdriverLogging.
locked
public locked: boolean;
Agent locked.
name
public name: string;
Agent name.
securitySettings
public securitySettings: string;
Agent securitySettings.
speechToTextSettings
public speechToTextSettings?: (google.cloud.dialogflow.cx.v3.ISpeechToTextSettings|null);
Agent speechToTextSettings.
startFlow
public startFlow: string;
Agent startFlow.
supportedLanguageCodes
public supportedLanguageCodes: string[];
Agent supportedLanguageCodes.
textToSpeechSettings
public textToSpeechSettings?: (google.cloud.dialogflow.cx.v3.ITextToSpeechSettings|null);
Agent textToSpeechSettings.
timeZone
public timeZone: string;
Agent timeZone.
Methods
create(properties)
public static create(properties?: google.cloud.dialogflow.cx.v3.IAgent): google.cloud.dialogflow.cx.v3.Agent;
Creates a new Agent instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IAgent
Properties to set |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflow.cx.v3.Agent | Agent instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.Agent;
Decodes an Agent 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.Agent | Agent |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.Agent;
Decodes an Agent 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.Agent | Agent |
encode(message, writer)
public static encode(message: google.cloud.dialogflow.cx.v3.IAgent, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Agent message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAgent
Agent 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.IAgent, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Agent message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAgent
Agent 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.Agent;
Creates an Agent 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.Agent | Agent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Agent
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 Agent to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dialogflow.cx.v3.Agent, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Agent message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
google.cloud.dialogflow.cx.v3.Agent
Agent |
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 an Agent message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|