Show / Hide Table of Contents

Class ReactionName

Resource name for the Reaction resource.

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

Constructors

ReactionName(string, string, string)

Constructs a new instance of a ReactionName class from the component parts of pattern spaces/{space}/messages/{message}/reactions/{reaction}

Declaration
public ReactionName(string spaceId, string messageId, string reactionId)
Parameters
Type Name Description
string spaceId

The Space ID. Must not be null or empty.

string messageId

The Message ID. Must not be null or empty.

string reactionId

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

MessageId

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

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

ReactionId

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

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

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 ReactionName.ResourceNameType of the contained resource name.

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

Formats the IDs into the string representation of this ReactionName with pattern spaces/{space}/messages/{message}/reactions/{reaction}.

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

The Space ID. Must not be null or empty.

string messageId

The Message ID. Must not be null or empty.

string reactionId

The Reaction ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ReactionName with pattern spaces/{space}/messages/{message}/reactions/{reaction}.

FormatSpaceMessageReaction(string, string, string)

Formats the IDs into the string representation of this ReactionName with pattern spaces/{space}/messages/{message}/reactions/{reaction}.

Declaration
public static string FormatSpaceMessageReaction(string spaceId, string messageId, string reactionId)
Parameters
Type Name Description
string spaceId

The Space ID. Must not be null or empty.

string messageId

The Message ID. Must not be null or empty.

string reactionId

The Reaction ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ReactionName with pattern spaces/{space}/messages/{message}/reactions/{reaction}.

FromSpaceMessageReaction(string, string, string)

Creates a ReactionName with the pattern spaces/{space}/messages/{message}/reactions/{reaction}.

Declaration
public static ReactionName FromSpaceMessageReaction(string spaceId, string messageId, string reactionId)
Parameters
Type Name Description
string spaceId

The Space ID. Must not be null or empty.

string messageId

The Message ID. Must not be null or empty.

string reactionId

The Reaction ID. Must not be null or empty.

Returns
Type Description
ReactionName

A new instance of ReactionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a ReactionName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
ReactionName

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

Declaration
public static ReactionName Parse(string reactionName)
Parameters
Type Name Description
string reactionName

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

Returns
Type Description
ReactionName

The parsed ReactionName if successful.

Remarks

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

  • spaces/{space}/messages/{message}/reactions/{reaction}

Parse(string, bool)

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

Declaration
public static ReactionName Parse(string reactionName, bool allowUnparsed)
Parameters
Type Name Description
string reactionName

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
ReactionName

The parsed ReactionName if successful.

Remarks

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

  • spaces/{space}/messages/{message}/reactions/{reaction}
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 ReactionName)

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

Declaration
public static bool TryParse(string reactionName, out ReactionName result)
Parameters
Type Name Description
string reactionName

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

ReactionName result

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

  • spaces/{space}/messages/{message}/reactions/{reaction}

TryParse(string, bool, out ReactionName)

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

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

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.

ReactionName result

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

  • spaces/{space}/messages/{message}/reactions/{reaction}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReactionName, ReactionName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

ReactionName 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