Class UserName

Resource name for the User resource.

Inheritance

object

UserName

Implements

IResourceName

IEquatable<UserName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class UserName : IResourceName, IEquatable<UserName>

Constructors

UserName(string, string)

Constructs a new instance of a UserName class from the component parts of pattern networks/{network_code}/users/{user}

Declaration

public UserName(string networkCodeId, string userId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	userId	The User 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

NetworkCodeId

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

Declaration

public string NetworkCodeId { get; }

Property Value

Type	Description
string

Type

The UserName.ResourceNameType of the contained resource name.

Declaration

public UserName.ResourceNameType Type { get; }

Property Value

Type	Description
UserName.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)

Formats the IDs into the string representation of this UserName with pattern networks/{network_code}/users/{user}.

Declaration

public static string Format(string networkCodeId, string userId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	userId	The User ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this UserName with pattern networks/{network_code}/users/{user}.

FormatNetworkCodeUser(string, string)

Formats the IDs into the string representation of this UserName with pattern networks/{network_code}/users/{user}.

Declaration

public static string FormatNetworkCodeUser(string networkCodeId, string userId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	userId	The User ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this UserName with pattern networks/{network_code}/users/{user}.

FromNetworkCodeUser(string, string)

Creates a UserName with the pattern networks/{network_code}/users/{user}.

Declaration

public static UserName FromNetworkCodeUser(string networkCodeId, string userId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	userId	The User ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a UserName containing an unparsed resource name.

Declaration

public static UserName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static UserName Parse(string userName)

Parameters

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

Returns

Type	Description
UserName	The parsed UserName if successful.

Remarks

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

• networks/{network_code}/users/{user}

Parse(string, bool)

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

Declaration

public static UserName Parse(string userName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/users/{user}

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

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

Declaration

public static bool TryParse(string userName, out UserName result)

Parameters

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

• networks/{network_code}/users/{user}

TryParse(string, bool, out UserName)

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

Declaration

public static bool TryParse(string userName, bool allowUnparsed, out UserName result)

Parameters

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

• networks/{network_code}/users/{user}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserName, UserName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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