Class PairedDeviceName

Resource name for the PairedDevice resource.

Inheritance

object

PairedDeviceName

Implements

IResourceName

IEquatable<PairedDeviceName>

Inherited Members

object.GetType()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class PairedDeviceName : IResourceName, IEquatable<PairedDeviceName>

Constructors

PairedDeviceName(string, string)

Constructs a new instance of a PairedDeviceName class from the component parts of pattern users/{user}/pairedDevices/{paired_device}

Declaration

public PairedDeviceName(string userId, string pairedDeviceId)

Parameters

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

PairedDeviceId

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

Declaration

public string PairedDeviceId { get; }

Property Value

Type	Description
string

Type

The PairedDeviceName.ResourceNameType of the contained resource name.

Declaration

public PairedDeviceName.ResourceNameType Type { get; }

Property Value

Type	Description
PairedDeviceName.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 PairedDeviceName with pattern users/{user}/pairedDevices/{paired_device}.

Declaration

public static string Format(string userId, string pairedDeviceId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	pairedDeviceId	The PairedDevice ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PairedDeviceName with pattern users/{user}/pairedDevices/{paired_device}.

FormatUserPairedDevice(string, string)

Formats the IDs into the string representation of this PairedDeviceName with pattern users/{user}/pairedDevices/{paired_device}.

Declaration

public static string FormatUserPairedDevice(string userId, string pairedDeviceId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	pairedDeviceId	The PairedDevice ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PairedDeviceName with pattern users/{user}/pairedDevices/{paired_device}.

FromUnparsed(UnparsedResourceName)

Creates a PairedDeviceName containing an unparsed resource name.

Declaration

public static PairedDeviceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
PairedDeviceName	A new instance of PairedDeviceName containing the provided unparsedResourceName.

FromUserPairedDevice(string, string)

Creates a PairedDeviceName with the pattern users/{user}/pairedDevices/{paired_device}.

Declaration

public static PairedDeviceName FromUserPairedDevice(string userId, string pairedDeviceId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	pairedDeviceId	The PairedDevice ID. Must not be null or empty.

Returns

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

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 PairedDeviceName instance.

Declaration

public static PairedDeviceName Parse(string pairedDeviceName)

Parameters

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

Returns

Type	Description
PairedDeviceName	The parsed PairedDeviceName if successful.

Remarks

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

• users/{user}/pairedDevices/{paired_device}

Parse(string, bool)

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

Declaration

public static PairedDeviceName Parse(string pairedDeviceName, bool allowUnparsed)

Parameters

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

Remarks

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

• users/{user}/pairedDevices/{paired_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 PairedDeviceName)

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

Declaration

public static bool TryParse(string pairedDeviceName, out PairedDeviceName result)

Parameters

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

• users/{user}/pairedDevices/{paired_device}

TryParse(string, bool, out PairedDeviceName)

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

Declaration

public static bool TryParse(string pairedDeviceName, bool allowUnparsed, out PairedDeviceName result)

Parameters

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

• users/{user}/pairedDevices/{paired_device}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PairedDeviceName, PairedDeviceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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