Class ParticipantName

Resource name for the Participant resource.

Inheritance

object

ParticipantName

Implements

IResourceName

IEquatable<ParticipantName>

Inherited Members

object.GetType()

Namespace: Google.Apps.Meet.V2

Assembly: Google.Apps.Meet.V2.dll

Syntax

public sealed class ParticipantName : IResourceName, IEquatable<ParticipantName>

Constructors

ParticipantName(string, string)

Constructs a new instance of a ParticipantName class from the component parts of pattern conferenceRecords/{conference_record}/participants/{participant}

Declaration

public ParticipantName(string conferenceRecordId, string participantId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	participantId	The Participant ID. Must not be null or empty.

Properties

ConferenceRecordId

The ConferenceRecord ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string ConferenceRecordId { get; }

Property Value

Type	Description
string

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

ParticipantId

The Participant ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string ParticipantId { get; }

Property Value

Type	Description
string

Type

The ParticipantName.ResourceNameType of the contained resource name.

Declaration

public ParticipantName.ResourceNameType Type { get; }

Property Value

Type	Description
ParticipantName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string)

Formats the IDs into the string representation of this ParticipantName with pattern conferenceRecords/{conference_record}/participants/{participant}.

Declaration

public static string Format(string conferenceRecordId, string participantId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	participantId	The Participant ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ParticipantName with pattern conferenceRecords/{conference_record}/participants/{participant}.

FormatConferenceRecordParticipant(string, string)

Formats the IDs into the string representation of this ParticipantName with pattern conferenceRecords/{conference_record}/participants/{participant}.

Declaration

public static string FormatConferenceRecordParticipant(string conferenceRecordId, string participantId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	participantId	The Participant ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ParticipantName with pattern conferenceRecords/{conference_record}/participants/{participant}.

FromConferenceRecordParticipant(string, string)

Creates a ParticipantName with the pattern conferenceRecords/{conference_record}/participants/{participant}.

Declaration

public static ParticipantName FromConferenceRecordParticipant(string conferenceRecordId, string participantId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	participantId	The Participant ID. Must not be null or empty.

Returns

Type	Description
ParticipantName	A new instance of ParticipantName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a ParticipantName containing an unparsed resource name.

Declaration

public static ParticipantName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
ParticipantName	A new instance of ParticipantName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

Parses the given resource name string into a new ParticipantName instance.

Declaration

public static ParticipantName Parse(string participantName)

Parameters

Type	Name	Description
string	participantName	The resource name in string form. Must not be null.

Returns

Type	Description
ParticipantName	The parsed ParticipantName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• conferenceRecords/{conference_record}/participants/{participant}

Parse(string, bool)

Parses the given resource name string into a new ParticipantName instance; optionally allowing an unparseable resource name.

Declaration

public static ParticipantName Parse(string participantName, bool allowUnparsed)

Parameters

Type	Name	Description
string	participantName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
ParticipantName	The parsed ParticipantName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• conferenceRecords/{conference_record}/participants/{participant}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out ParticipantName)

Tries to parse the given resource name string into a new ParticipantName instance.

Declaration

public static bool TryParse(string participantName, out ParticipantName result)

Parameters

Type	Name	Description
string	participantName	The resource name in string form. Must not be null.
ParticipantName	result	When this method returns, the parsed ParticipantName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• conferenceRecords/{conference_record}/participants/{participant}

TryParse(string, bool, out ParticipantName)

Tries to parse the given resource name string into a new ParticipantName instance; optionally allowing an unparseable resource name.

Declaration

public static bool TryParse(string participantName, bool allowUnparsed, out ParticipantName result)

Parameters

Type	Name	Description
string	participantName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
ParticipantName	result	When this method returns, the parsed ParticipantName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• conferenceRecords/{conference_record}/participants/{participant}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ParticipantName, ParticipantName)

Determines whether two specified resource names have the same value.

Declaration

public static bool operator ==(ParticipantName a, ParticipantName b)

Parameters

Type	Name	Description
ParticipantName	a	The first resource name to compare, or null.
ParticipantName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(ParticipantName, ParticipantName)

Determines whether two specified resource names have different values.

Declaration

public static bool operator !=(ParticipantName a, ParticipantName b)

Parameters

Type	Name	Description
ParticipantName	a	The first resource name to compare, or null.
ParticipantName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.