Class protos.google.cloud.dialogflow.v2.GuidanceInstruction (8.4.0)

Represents a GuidanceInstruction.

Implements

Package

@google-cloud/dialogflow

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.v2.IGuidanceInstruction);

Constructs a new GuidanceInstruction.

Parameter
Name Description
properties IGuidanceInstruction

Properties to set

Properties

actions

public actions: google.cloud.dialogflow.v2.GuidanceInstruction.IAction[];

GuidanceInstruction actions.

condition

public condition: string;

GuidanceInstruction condition.

disableSuggestedReply

public disableSuggestedReply: boolean;

GuidanceInstruction disableSuggestedReply.

displayDetails

public displayDetails: string;

GuidanceInstruction displayDetails.

displayName

public displayName: string;

GuidanceInstruction displayName.

triggerEvent

public triggerEvent: (google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent|keyof typeof google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent);

GuidanceInstruction triggerEvent.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2.IGuidanceInstruction): google.cloud.dialogflow.v2.GuidanceInstruction;

Creates a new GuidanceInstruction instance using the specified properties.

Parameter
Name Description
properties IGuidanceInstruction

Properties to set

Returns
Type Description
GuidanceInstruction

GuidanceInstruction instance

decode(reader, length)

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

Decodes a GuidanceInstruction message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
GuidanceInstruction

GuidanceInstruction

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.v2.GuidanceInstruction;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GuidanceInstruction

GuidanceInstruction

encode(message, writer)

public static encode(message: google.cloud.dialogflow.v2.IGuidanceInstruction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GuidanceInstruction message. Does not implicitly messages.

Parameters
Name Description
message IGuidanceInstruction

GuidanceInstruction 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.v2.IGuidanceInstruction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGuidanceInstruction

GuidanceInstruction 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.v2.GuidanceInstruction;

Creates a GuidanceInstruction 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
GuidanceInstruction

GuidanceInstruction

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GuidanceInstruction

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 GuidanceInstruction to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message GuidanceInstruction

GuidanceInstruction

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 GuidanceInstruction 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