Class PhotoName

Resource name for the Photo resource.

Inheritance

object

PhotoName

Implements

IResourceName

IEquatable<PhotoName>

Inherited Members

object.GetType()

Namespace: Google.Maps.Places.V1

Assembly: Google.Maps.Places.V1.dll

Syntax

public sealed class PhotoName : IResourceName, IEquatable<PhotoName>

Constructors

PhotoName(string, string)

Constructs a new instance of a PhotoName class from the component parts of pattern places/{place}/photos/{photo}

Declaration

public PhotoName(string placeId, string photoId)

Parameters

Type	Name	Description
string	placeId	The Place ID. Must not be null or empty.
string	photoId	The Photo 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

PhotoId

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

Declaration

public string PhotoId { get; }

Property Value

Type	Description
string

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

Declaration

public PhotoName.ResourceNameType Type { get; }

Property Value

Type	Description
PhotoName.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 PhotoName with pattern places/{place}/photos/{photo}.

Declaration

public static string Format(string placeId, string photoId)

Parameters

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

Returns

Type	Description
string	The string representation of this PhotoName with pattern places/{place}/photos/{photo}.

FormatPlacePhoto(string, string)

Formats the IDs into the string representation of this PhotoName with pattern places/{place}/photos/{photo}.

Declaration

public static string FormatPlacePhoto(string placeId, string photoId)

Parameters

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

Returns

Type	Description
string	The string representation of this PhotoName with pattern places/{place}/photos/{photo}.

FromPlacePhoto(string, string)

Creates a PhotoName with the pattern places/{place}/photos/{photo}.

Declaration

public static PhotoName FromPlacePhoto(string placeId, string photoId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a PhotoName containing an unparsed resource name.

Declaration

public static PhotoName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static PhotoName Parse(string photoName)

Parameters

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

Returns

Type	Description
PhotoName	The parsed PhotoName if successful.

Remarks

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

• places/{place}/photos/{photo}

Parse(string, bool)

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

Declaration

public static PhotoName Parse(string photoName, bool allowUnparsed)

Parameters

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

Remarks

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

• places/{place}/photos/{photo}

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

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

Declaration

public static bool TryParse(string photoName, out PhotoName result)

Parameters

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

TryParse(string, bool, out PhotoName)

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

Declaration

public static bool TryParse(string photoName, bool allowUnparsed, out PhotoName result)

Parameters

Type	Name	Description
string	photoName	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.
PhotoName	result	When this method returns, the parsed PhotoName, 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}/photos/{photo}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PhotoName, PhotoName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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