Show / Hide Table of Contents

Class ThreadReadStateName

Resource name for the ThreadReadState resource.

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

Constructors

ThreadReadStateName(string, string, string)

Constructs a new instance of a ThreadReadStateName class from the component parts of pattern users/{user}/spaces/{space}/threads/{thread}/threadReadState

Declaration
public ThreadReadStateName(string userId, string spaceId, string threadId)
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.

string threadId

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

ThreadId

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

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

Type

The ThreadReadStateName.ResourceNameType of the contained resource name.

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

Formats the IDs into the string representation of this ThreadReadStateName with pattern users/{user}/spaces/{space}/threads/{thread}/threadReadState.

Declaration
public static string Format(string userId, string spaceId, string threadId)
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.

string threadId

The Thread ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ThreadReadStateName with pattern users/{user}/spaces/{space}/threads/{thread}/threadReadState.

FormatUserSpaceThread(string, string, string)

Formats the IDs into the string representation of this ThreadReadStateName with pattern users/{user}/spaces/{space}/threads/{thread}/threadReadState.

Declaration
public static string FormatUserSpaceThread(string userId, string spaceId, string threadId)
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.

string threadId

The Thread ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ThreadReadStateName with pattern users/{user}/spaces/{space}/threads/{thread}/threadReadState.

FromUnparsed(UnparsedResourceName)

Creates a ThreadReadStateName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
ThreadReadStateName

A new instance of ThreadReadStateName containing the provided unparsedResourceName.

FromUserSpaceThread(string, string, string)

Creates a ThreadReadStateName with the pattern users/{user}/spaces/{space}/threads/{thread}/threadReadState.

Declaration
public static ThreadReadStateName FromUserSpaceThread(string userId, string spaceId, string threadId)
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.

string threadId

The Thread ID. Must not be null or empty.

Returns
Type Description
ThreadReadStateName

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

Declaration
public static ThreadReadStateName Parse(string threadReadStateName)
Parameters
Type Name Description
string threadReadStateName

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

Returns
Type Description
ThreadReadStateName

The parsed ThreadReadStateName if successful.

Remarks

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

  • users/{user}/spaces/{space}/threads/{thread}/threadReadState

Parse(string, bool)

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

Declaration
public static ThreadReadStateName Parse(string threadReadStateName, bool allowUnparsed)
Parameters
Type Name Description
string threadReadStateName

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
ThreadReadStateName

The parsed ThreadReadStateName if successful.

Remarks

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

  • users/{user}/spaces/{space}/threads/{thread}/threadReadState
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 ThreadReadStateName)

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

Declaration
public static bool TryParse(string threadReadStateName, out ThreadReadStateName result)
Parameters
Type Name Description
string threadReadStateName

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

ThreadReadStateName result

When this method returns, the parsed ThreadReadStateName, 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}/threads/{thread}/threadReadState

TryParse(string, bool, out ThreadReadStateName)

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

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

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.

ThreadReadStateName result

When this method returns, the parsed ThreadReadStateName, 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}/threads/{thread}/threadReadState
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ThreadReadStateName, ThreadReadStateName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

ThreadReadStateName 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