Class PlaceName

Resource name for the Place resource.

Inheritance

object

PlaceName

Implements

IResourceName

IEquatable<PlaceName>

Inherited Members

object.GetType()

Namespace: Google.Maps.Places.V1

Assembly: Google.Maps.Places.V1.dll

Syntax

public sealed class PlaceName : IResourceName, IEquatable<PlaceName>

Constructors

PlaceName(string)

Constructs a new instance of a PlaceName class from the component parts of pattern places/{place_id}

Declaration

public PlaceName(string placeId)

Parameters

Type	Name	Description
string	placeId	The Place 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

PlaceId

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

Declaration

public string PlaceId { get; }

Property Value

Type	Description
string

Type

The PlaceName.ResourceNameType of the contained resource name.

Declaration

public PlaceName.ResourceNameType Type { get; }

Property Value

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

Formats the IDs into the string representation of this PlaceName with pattern places/{place_id}.

Declaration

public static string Format(string placeId)

Parameters

Type	Name	Description
string	placeId	The Place ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PlaceName with pattern places/{place_id}.

FormatPlace(string)

Formats the IDs into the string representation of this PlaceName with pattern places/{place_id}.

Declaration

public static string FormatPlace(string placeId)

Parameters

Type	Name	Description
string	placeId	The Place ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PlaceName with pattern places/{place_id}.

FromPlace(string)

Creates a PlaceName with the pattern places/{place_id}.

Declaration

public static PlaceName FromPlace(string placeId)

Parameters

Type	Name	Description
string	placeId	The Place ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a PlaceName containing an unparsed resource name.

Declaration

public static PlaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static PlaceName Parse(string placeName)

Parameters

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

Returns

Type	Description
PlaceName	The parsed PlaceName if successful.

Remarks

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

• places/{place_id}

Parse(string, bool)

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

Declaration

public static PlaceName Parse(string placeName, bool allowUnparsed)

Parameters

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

Remarks

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

• places/{place_id}

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

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

Declaration

public static bool TryParse(string placeName, out PlaceName result)

Parameters

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

• places/{place_id}

TryParse(string, bool, out PlaceName)

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

Declaration

public static bool TryParse(string placeName, bool allowUnparsed, out PlaceName result)

Parameters

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

• places/{place_id}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PlaceName, PlaceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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