Show / Hide Table of Contents

Class SpaceReadStateName

Resource name for the SpaceReadState resource.

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

Constructors

SpaceReadStateName(string, string)

Constructs a new instance of a SpaceReadStateName class from the component parts of pattern users/{user}/spaces/{space}/spaceReadState

Declaration
public SpaceReadStateName(string userId, string spaceId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

string spaceId

The Space 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

SpaceId

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

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

Type

The SpaceReadStateName.ResourceNameType of the contained resource name.

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

Formats the IDs into the string representation of this SpaceReadStateName with pattern users/{user}/spaces/{space}/spaceReadState.

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

The User ID. Must not be null or empty.

string spaceId

The Space ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this SpaceReadStateName with pattern users/{user}/spaces/{space}/spaceReadState.

FormatUserSpace(string, string)

Formats the IDs into the string representation of this SpaceReadStateName with pattern users/{user}/spaces/{space}/spaceReadState.

Declaration
public static string FormatUserSpace(string userId, string spaceId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

string spaceId

The Space ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this SpaceReadStateName with pattern users/{user}/spaces/{space}/spaceReadState.

FromUnparsed(UnparsedResourceName)

Creates a SpaceReadStateName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
SpaceReadStateName

A new instance of SpaceReadStateName containing the provided unparsedResourceName.

FromUserSpace(string, string)

Creates a SpaceReadStateName with the pattern users/{user}/spaces/{space}/spaceReadState .

Declaration
public static SpaceReadStateName FromUserSpace(string userId, string spaceId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

string spaceId

The Space ID. Must not be null or empty.

Returns
Type Description
SpaceReadStateName

A new instance of SpaceReadStateName 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 SpaceReadStateName instance.

Declaration
public static SpaceReadStateName Parse(string spaceReadStateName)
Parameters
Type Name Description
string spaceReadStateName

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

Returns
Type Description
SpaceReadStateName

The parsed SpaceReadStateName if successful.

Remarks

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

  • users/{user}/spaces/{space}/spaceReadState

Parse(string, bool)

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

Declaration
public static SpaceReadStateName Parse(string spaceReadStateName, bool allowUnparsed)
Parameters
Type Name Description
string spaceReadStateName

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
SpaceReadStateName

The parsed SpaceReadStateName if successful.

Remarks

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

  • users/{user}/spaces/{space}/spaceReadState
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 SpaceReadStateName)

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

Declaration
public static bool TryParse(string spaceReadStateName, out SpaceReadStateName result)
Parameters
Type Name Description
string spaceReadStateName

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

SpaceReadStateName result

When this method returns, the parsed SpaceReadStateName, 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}/spaces/{space}/spaceReadState

TryParse(string, bool, out SpaceReadStateName)

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

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

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.

SpaceReadStateName result

When this method returns, the parsed SpaceReadStateName, 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}/spaces/{space}/spaceReadState
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SpaceReadStateName, SpaceReadStateName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

SpaceReadStateName 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