Class protos.google.cloud.dialogflow.v2beta1.Conversation (4.1.4)

Represents a Conversation.

Package

@google-cloud/dialogflow!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.v2beta1.IConversation);

Constructs a new Conversation.

Parameter

Name	Description
properties	`IConversation` Properties to set

Properties

conversationProfile

public conversationProfile: string;

Conversation conversationProfile.

Property Value

Type	Description
string

conversationStage

public conversationStage: (google.cloud.dialogflow.v2beta1.Conversation.ConversationStage|keyof typeof google.cloud.dialogflow.v2beta1.Conversation.ConversationStage);

Conversation conversationStage.

Property Value

Type	Description
(google.cloud.dialogflow.v2beta1.Conversation.ConversationStage\|keyof typeof google.cloud.dialogflow.v2beta1.Conversation.ConversationStage)

endTime

public endTime?: (google.protobuf.ITimestamp|null);

Conversation endTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

lifecycleState

public lifecycleState: (google.cloud.dialogflow.v2beta1.Conversation.LifecycleState|keyof typeof google.cloud.dialogflow.v2beta1.Conversation.LifecycleState);

Conversation lifecycleState.

Property Value

Type	Description
(google.cloud.dialogflow.v2beta1.Conversation.LifecycleState\|keyof typeof google.cloud.dialogflow.v2beta1.Conversation.LifecycleState)

name

public name: string;

Conversation name.

Property Value

Type	Description
string

phoneNumber

public phoneNumber?: (google.cloud.dialogflow.v2beta1.IConversationPhoneNumber|null);

Conversation phoneNumber.

Property Value

Type	Description
(google.cloud.dialogflow.v2beta1.IConversationPhoneNumber\|null)

startTime

public startTime?: (google.protobuf.ITimestamp|null);

Conversation startTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2beta1.IConversation): google.cloud.dialogflow.v2beta1.Conversation;

Creates a new Conversation instance using the specified properties.

Parameter

Name	Description
properties	`IConversation` Properties to set

Returns

Type	Description
google.cloud.dialogflow.v2beta1.Conversation	Conversation instance

decode(reader, length)

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

Decodes a Conversation 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.v2beta1.Conversation	Conversation

decodeDelimited(reader)

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

Decodes a Conversation 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.v2beta1.Conversation	Conversation

encode(message, writer)

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

Encodes the specified Conversation message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IConversation` Conversation 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.v2beta1.Conversation;

Creates a Conversation 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.v2beta1.Conversation	Conversation

toJSON()

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

Converts this Conversation to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dialogflow.v2beta1.Conversation` Conversation
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 Conversation 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