Class AttachmentName

Resource name for the Attachment resource.

Inheritance

object

AttachmentName

Implements

IResourceName

IEquatable<AttachmentName>

Inherited Members

object.GetType()

Namespace: Google.Apps.Chat.V1

Assembly: Google.Apps.Chat.V1.dll

Syntax

public sealed class AttachmentName : IResourceName, IEquatable<AttachmentName>

Constructors

AttachmentName(string, string, string)

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

Declaration

public AttachmentName(string spaceId, string messageId, string attachmentId)

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	attachmentId	The Attachment ID. Must not be null or empty.

Properties

AttachmentId

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

Declaration

public string AttachmentId { get; }

Property Value

Type	Description
string

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

Declaration

public AttachmentName.ResourceNameType Type { get; }

Property Value

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

Declaration

public static string Format(string spaceId, string messageId, string attachmentId)

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	attachmentId	The Attachment ID. Must not be null or empty.

Returns

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

FormatSpaceMessageAttachment(string, string, string)

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

Declaration

public static string FormatSpaceMessageAttachment(string spaceId, string messageId, string attachmentId)

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	attachmentId	The Attachment ID. Must not be null or empty.

Returns

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

FromSpaceMessageAttachment(string, string, string)

Creates a AttachmentName with the pattern spaces/{space}/messages/{message}/attachments/{attachment}.

Declaration

public static AttachmentName FromSpaceMessageAttachment(string spaceId, string messageId, string attachmentId)

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	attachmentId	The Attachment ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AttachmentName containing an unparsed resource name.

Declaration

public static AttachmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static AttachmentName Parse(string attachmentName)

Parameters

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

Returns

Type	Description
AttachmentName	The parsed AttachmentName if successful.

Remarks

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

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

Parse(string, bool)

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

Declaration

public static AttachmentName Parse(string attachmentName, bool allowUnparsed)

Parameters

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

Remarks

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

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

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

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

Declaration

public static bool TryParse(string attachmentName, out AttachmentName result)

Parameters

Type	Name	Description
string	attachmentName	The resource name in string form. Must not be null.
AttachmentName	result	When this method returns, the parsed AttachmentName, 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}/attachments/{attachment}

TryParse(string, bool, out AttachmentName)

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

Declaration

public static bool TryParse(string attachmentName, bool allowUnparsed, out AttachmentName result)

Parameters

Type	Name	Description
string	attachmentName	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.
AttachmentName	result	When this method returns, the parsed AttachmentName, 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}/attachments/{attachment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AttachmentName, AttachmentName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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