Class protos.google.cloud.dialogflow.v2.Participant

Represents a Participant.

Package

@google-cloud/dialogflow

Constructors

(constructor)(properties)

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

Constructs a new Participant.

Parameter
NameDescription
properties IParticipant

Properties to set

Properties

documentsMetadataFilters

public documentsMetadataFilters: { [k: string]: string };

Participant documentsMetadataFilters.

name

public name: string;

Participant name.

role

public role: (google.cloud.dialogflow.v2.Participant.Role|keyof typeof google.cloud.dialogflow.v2.Participant.Role);

Participant role.

sipRecordingMediaLabel

public sipRecordingMediaLabel: string;

Participant sipRecordingMediaLabel.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2.IParticipant): google.cloud.dialogflow.v2.Participant;

Creates a new Participant instance using the specified properties.

Parameter
NameDescription
properties IParticipant

Properties to set

Returns
TypeDescription
google.cloud.dialogflow.v2.Participant

Participant instance

decode(reader, length)

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

Decodes a Participant message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dialogflow.v2.Participant

Participant

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dialogflow.v2.Participant

Participant

encode(message, writer)

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

Encodes the specified Participant message. Does not implicitly messages.

Parameters
NameDescription
message IParticipant

Participant message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IParticipant

Participant message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.v2.Participant;

Creates a Participant message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.dialogflow.v2.Participant

Participant

toJSON()

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

Converts this Participant to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dialogflow.v2.Participant

Participant

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Participant message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not