Class PhotoMediaName

Resource name for the PhotoMedia resource.

Inheritance

object

PhotoMediaName

Implements

IResourceName

IEquatable<PhotoMediaName>

Inherited Members

object.GetType()

Namespace: Google.Maps.Places.V1

Assembly: Google.Maps.Places.V1.dll

Syntax

public sealed class PhotoMediaName : IResourceName, IEquatable<PhotoMediaName>

Constructors

PhotoMediaName(string, string)

Constructs a new instance of a PhotoMediaName class from the component parts of pattern places/{place_id}/photos/{photo_reference}/media

Declaration

public PhotoMediaName(string placeId, string photoReferenceId)

Parameters

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

PhotoReferenceId

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

Declaration

public string PhotoReferenceId { 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 PhotoMediaName.ResourceNameType of the contained resource name.

Declaration

public PhotoMediaName.ResourceNameType Type { get; }

Property Value

Type	Description
PhotoMediaName.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 PhotoMediaName with pattern places/{place_id}/photos/{photo_reference}/media.

Declaration

public static string Format(string placeId, string photoReferenceId)

Parameters

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

Returns

Type	Description
string	The string representation of this PhotoMediaName with pattern places/{place_id}/photos/{photo_reference}/media.

FormatPlacePhotoReference(string, string)

Formats the IDs into the string representation of this PhotoMediaName with pattern places/{place_id}/photos/{photo_reference}/media.

Declaration

public static string FormatPlacePhotoReference(string placeId, string photoReferenceId)

Parameters

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

Returns

Type	Description
string	The string representation of this PhotoMediaName with pattern places/{place_id}/photos/{photo_reference}/media.

FromPlacePhotoReference(string, string)

Creates a PhotoMediaName with the pattern places/{place_id}/photos/{photo_reference}/media .

Declaration

public static PhotoMediaName FromPlacePhotoReference(string placeId, string photoReferenceId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a PhotoMediaName containing an unparsed resource name.

Declaration

public static PhotoMediaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static PhotoMediaName Parse(string photoMediaName)

Parameters

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

Returns

Type	Description
PhotoMediaName	The parsed PhotoMediaName if successful.

Remarks

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

• places/{place_id}/photos/{photo_reference}/media

Parse(string, bool)

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

Declaration

public static PhotoMediaName Parse(string photoMediaName, bool allowUnparsed)

Parameters

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

Remarks

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

• places/{place_id}/photos/{photo_reference}/media

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

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

Declaration

public static bool TryParse(string photoMediaName, out PhotoMediaName result)

Parameters

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

TryParse(string, bool, out PhotoMediaName)

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

Declaration

public static bool TryParse(string photoMediaName, bool allowUnparsed, out PhotoMediaName result)

Parameters

Type	Name	Description
string	photoMediaName	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.
PhotoMediaName	result	When this method returns, the parsed PhotoMediaName, 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}/photos/{photo_reference}/media

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PhotoMediaName, PhotoMediaName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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