Class MessageName

Resource name for the Message resource.

Inheritance

object

MessageName

Implements

IResourceName

IEquatable<MessageName>

Inherited Members

object.GetType()

Namespace: Google.Apps.Chat.V1

Assembly: Google.Apps.Chat.V1.dll

Syntax

public sealed class MessageName : IResourceName, IEquatable<MessageName>

Constructors

MessageName(string, string)

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

Declaration

public MessageName(string spaceId, string messageId)

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.

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

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

Declaration

public MessageName.ResourceNameType Type { get; }

Property Value

Type	Description
MessageName.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 MessageName with pattern spaces/{space}/messages/{message}.

Declaration

public static string Format(string spaceId, string messageId)

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.

Returns

Type	Description
string	The string representation of this MessageName with pattern spaces/{space}/messages/{message}.

FormatSpaceMessage(string, string)

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

Declaration

public static string FormatSpaceMessage(string spaceId, string messageId)

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.

Returns

Type	Description
string	The string representation of this MessageName with pattern spaces/{space}/messages/{message}.

FromSpaceMessage(string, string)

Creates a MessageName with the pattern spaces/{space}/messages/{message}.

Declaration

public static MessageName FromSpaceMessage(string spaceId, string messageId)

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.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a MessageName containing an unparsed resource name.

Declaration

public static MessageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
MessageName	A new instance of MessageName 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 MessageName instance.

Declaration

public static MessageName Parse(string messageName)

Parameters

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

Returns

Type	Description
MessageName	The parsed MessageName if successful.

Remarks

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

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

Parse(string, bool)

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

Declaration

public static MessageName Parse(string messageName, bool allowUnparsed)

Parameters

Type	Name	Description
string	messageName	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
MessageName	The parsed MessageName if successful.

Remarks

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

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

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

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

Declaration

public static bool TryParse(string messageName, out MessageName result)

Parameters

Type	Name	Description
string	messageName	The resource name in string form. Must not be null.
MessageName	result	When this method returns, the parsed MessageName, 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}

TryParse(string, bool, out MessageName)

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

Declaration

public static bool TryParse(string messageName, bool allowUnparsed, out MessageName result)

Parameters

Type	Name	Description
string	messageName	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.
MessageName	result	When this method returns, the parsed MessageName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MessageName, MessageName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
MessageName	a	The first resource name to compare, or null.
MessageName	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 !=(MessageName, MessageName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
MessageName	a	The first resource name to compare, or null.
MessageName	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.