Class MobileDeviceName

Resource name for the MobileDevice resource.

Inheritance

object

MobileDeviceName

Implements

IResourceName

IEquatable<MobileDeviceName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class MobileDeviceName : IResourceName, IEquatable<MobileDeviceName>

Constructors

MobileDeviceName(string, string)

Constructs a new instance of a MobileDeviceName class from the component parts of pattern networks/{network_code}/mobileDevices/{mobile_device}

Declaration

public MobileDeviceName(string networkCodeId, string mobileDeviceId)

Parameters

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

MobileDeviceId

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

Declaration

public string MobileDeviceId { get; }

Property Value

Type	Description
string

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

Declaration

public MobileDeviceName.ResourceNameType Type { get; }

Property Value

Type	Description
MobileDeviceName.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 MobileDeviceName with pattern networks/{network_code}/mobileDevices/{mobile_device}.

Declaration

public static string Format(string networkCodeId, string mobileDeviceId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	mobileDeviceId	The MobileDevice ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this MobileDeviceName with pattern networks/{network_code}/mobileDevices/{mobile_device}.

FormatNetworkCodeMobileDevice(string, string)

Formats the IDs into the string representation of this MobileDeviceName with pattern networks/{network_code}/mobileDevices/{mobile_device}.

Declaration

public static string FormatNetworkCodeMobileDevice(string networkCodeId, string mobileDeviceId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	mobileDeviceId	The MobileDevice ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this MobileDeviceName with pattern networks/{network_code}/mobileDevices/{mobile_device}.

FromNetworkCodeMobileDevice(string, string)

Creates a MobileDeviceName with the pattern networks/{network_code}/mobileDevices/{mobile_device}.

Declaration

public static MobileDeviceName FromNetworkCodeMobileDevice(string networkCodeId, string mobileDeviceId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	mobileDeviceId	The MobileDevice ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a MobileDeviceName containing an unparsed resource name.

Declaration

public static MobileDeviceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static MobileDeviceName Parse(string mobileDeviceName)

Parameters

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

Returns

Type	Description
MobileDeviceName	The parsed MobileDeviceName if successful.

Remarks

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

• networks/{network_code}/mobileDevices/{mobile_device}

Parse(string, bool)

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

Declaration

public static MobileDeviceName Parse(string mobileDeviceName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/mobileDevices/{mobile_device}

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

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

Declaration

public static bool TryParse(string mobileDeviceName, out MobileDeviceName result)

Parameters

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

TryParse(string, bool, out MobileDeviceName)

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

Declaration

public static bool TryParse(string mobileDeviceName, bool allowUnparsed, out MobileDeviceName result)

Parameters

Type	Name	Description
string	mobileDeviceName	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.
MobileDeviceName	result	When this method returns, the parsed MobileDeviceName, 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}/mobileDevices/{mobile_device}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MobileDeviceName, MobileDeviceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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