Class EmailPreferencesName

Resource name for the EmailPreferences resource.

Inheritance

object

EmailPreferencesName

Implements

IResourceName

IEquatable<EmailPreferencesName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

Assembly: Google.Shopping.Merchant.Accounts.V1.dll

Syntax

public sealed class EmailPreferencesName : IResourceName, IEquatable<EmailPreferencesName>

Constructors

EmailPreferencesName(string, string)

Constructs a new instance of a EmailPreferencesName class from the component parts of pattern accounts/{account}/users/{email}/emailPreferences

Declaration

public EmailPreferencesName(string accountId, string emailId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	emailId	The Email ID. Must not be null or empty.

Properties

AccountId

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

Declaration

public string AccountId { get; }

Property Value

Type	Description
string

EmailId

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

Declaration

public string EmailId { 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

Type

The EmailPreferencesName.ResourceNameType of the contained resource name.

Declaration

public EmailPreferencesName.ResourceNameType Type { get; }

Property Value

Type	Description
EmailPreferencesName.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 EmailPreferencesName with pattern accounts/{account}/users/{email}/emailPreferences.

Declaration

public static string Format(string accountId, string emailId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	emailId	The Email ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this EmailPreferencesName with pattern accounts/{account}/users/{email}/emailPreferences.

FormatAccountEmail(string, string)

Formats the IDs into the string representation of this EmailPreferencesName with pattern accounts/{account}/users/{email}/emailPreferences.

Declaration

public static string FormatAccountEmail(string accountId, string emailId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	emailId	The Email ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this EmailPreferencesName with pattern accounts/{account}/users/{email}/emailPreferences.

FromAccountEmail(string, string)

Creates a EmailPreferencesName with the pattern accounts/{account}/users/{email}/emailPreferences.

Declaration

public static EmailPreferencesName FromAccountEmail(string accountId, string emailId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	emailId	The Email ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a EmailPreferencesName containing an unparsed resource name.

Declaration

public static EmailPreferencesName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static EmailPreferencesName Parse(string emailPreferencesName)

Parameters

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

Returns

Type	Description
EmailPreferencesName	The parsed EmailPreferencesName if successful.

Remarks

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

• accounts/{account}/users/{email}/emailPreferences

Parse(string, bool)

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

Declaration

public static EmailPreferencesName Parse(string emailPreferencesName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/users/{email}/emailPreferences

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

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

Declaration

public static bool TryParse(string emailPreferencesName, out EmailPreferencesName result)

Parameters

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

• accounts/{account}/users/{email}/emailPreferences

TryParse(string, bool, out EmailPreferencesName)

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

Declaration

public static bool TryParse(string emailPreferencesName, bool allowUnparsed, out EmailPreferencesName result)

Parameters

Type	Name	Description
string	emailPreferencesName	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.
EmailPreferencesName	result	When this method returns, the parsed EmailPreferencesName, 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:

• accounts/{account}/users/{email}/emailPreferences

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EmailPreferencesName, EmailPreferencesName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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