Class SettingsName

Resource name for the Settings resource.

Inheritance

object

SettingsName

Implements

IResourceName

IEquatable<SettingsName>

Inherited Members

object.GetType()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class SettingsName : IResourceName, IEquatable<SettingsName>

Constructors

SettingsName(string)

Constructs a new instance of a SettingsName class from the component parts of pattern users/{user}/settings

Declaration

public SettingsName(string userId)

Parameters

Type	Name	Description
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

Type

The SettingsName.ResourceNameType of the contained resource name.

Declaration

public SettingsName.ResourceNameType Type { get; }

Property Value

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

Formats the IDs into the string representation of this SettingsName with pattern users/{user}/settings.

Declaration

public static string Format(string userId)

Parameters

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

Returns

Type	Description
string	The string representation of this SettingsName with pattern users/{user}/settings.

FormatUser(string)

Formats the IDs into the string representation of this SettingsName with pattern users/{user}/settings.

Declaration

public static string FormatUser(string userId)

Parameters

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

Returns

Type	Description
string	The string representation of this SettingsName with pattern users/{user}/settings.

FromUnparsed(UnparsedResourceName)

Creates a SettingsName containing an unparsed resource name.

Declaration

public static SettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

FromUser(string)

Creates a SettingsName with the pattern users/{user}/settings.

Declaration

public static SettingsName FromUser(string userId)

Parameters

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

Returns

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

Declaration

public static SettingsName Parse(string settingsName)

Parameters

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

Returns

Type	Description
SettingsName	The parsed SettingsName if successful.

Remarks

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

• users/{user}/settings

Parse(string, bool)

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

Declaration

public static SettingsName Parse(string settingsName, bool allowUnparsed)

Parameters

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

Remarks

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

• users/{user}/settings

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

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

Declaration

public static bool TryParse(string settingsName, out SettingsName result)

Parameters

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

TryParse(string, bool, out SettingsName)

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

Declaration

public static bool TryParse(string settingsName, bool allowUnparsed, out SettingsName result)

Parameters

Type	Name	Description
string	settingsName	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.
SettingsName	result	When this method returns, the parsed SettingsName, 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}/settings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SettingsName, SettingsName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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