Show / Hide Table of Contents

Class AvailabilityName

Resource name for the Availability resource.

Inheritance
object
AvailabilityName
Implements
IResourceName
IEquatable<AvailabilityName>
Inherited Members
object.GetType()
Namespace: Google.Apps.Chat.V1
Assembly: Google.Apps.Chat.V1.dll
Syntax
public sealed class AvailabilityName : IResourceName, IEquatable<AvailabilityName>

Constructors

AvailabilityName(string)

Constructs a new instance of a AvailabilityName class from the component parts of pattern users/{user}/availability

Declaration
public AvailabilityName(string userId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

Properties

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

Type

The AvailabilityName.ResourceNameType of the contained resource name.

Declaration
public AvailabilityName.ResourceNameType Type { get; }
Property Value
Type Description
AvailabilityName.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

UserId

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

Declaration
public string UserId { get; }
Property Value
Type Description
string

Methods

Format(string)

Formats the IDs into the string representation of this AvailabilityName with pattern users/{user}/availability.

Declaration
public static string Format(string userId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AvailabilityName with pattern users/{user}/availability .

FormatUser(string)

Formats the IDs into the string representation of this AvailabilityName with pattern users/{user}/availability.

Declaration
public static string FormatUser(string userId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AvailabilityName with pattern users/{user}/availability .

FromUnparsed(UnparsedResourceName)

Creates a AvailabilityName containing an unparsed resource name.

Declaration
public static AvailabilityName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
AvailabilityName

A new instance of AvailabilityName containing the provided unparsedResourceName.

FromUser(string)

Creates a AvailabilityName with the pattern users/{user}/availability.

Declaration
public static AvailabilityName FromUser(string userId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

Returns
Type Description
AvailabilityName

A new instance of AvailabilityName constructed from the provided ids.

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 AvailabilityName instance.

Declaration
public static AvailabilityName Parse(string availabilityName)
Parameters
Type Name Description
string availabilityName

The resource name in string form. Must not be null.

Returns
Type Description
AvailabilityName

The parsed AvailabilityName if successful.

Remarks

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

  • users/{user}/availability

Parse(string, bool)

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

Declaration
public static AvailabilityName Parse(string availabilityName, bool allowUnparsed)
Parameters
Type Name Description
string availabilityName

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
AvailabilityName

The parsed AvailabilityName if successful.

Remarks

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

  • users/{user}/availability

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 AvailabilityName)

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

Declaration
public static bool TryParse(string availabilityName, out AvailabilityName result)
Parameters
Type Name Description
string availabilityName

The resource name in string form. Must not be null.

AvailabilityName result

When this method returns, the parsed AvailabilityName, 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:

  • users/{user}/availability

TryParse(string, bool, out AvailabilityName)

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

Declaration
public static bool TryParse(string availabilityName, bool allowUnparsed, out AvailabilityName result)
Parameters
Type Name Description
string availabilityName

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.

AvailabilityName result

When this method returns, the parsed AvailabilityName, 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:

  • users/{user}/availability

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AvailabilityName, AvailabilityName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(AvailabilityName a, AvailabilityName b)
Parameters
Type Name Description
AvailabilityName a

The first resource name to compare, or null.

AvailabilityName 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 !=(AvailabilityName, AvailabilityName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(AvailabilityName a, AvailabilityName b)
Parameters
Type Name Description
AvailabilityName a

The first resource name to compare, or null.

AvailabilityName 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.

In this article
Back to top Generated by DocFX