One Logo Pool Ball
GeoToolbox · IOS API REFERENCE

PlaceDescriptor

struct · iOS 26.0+ · SDK 27.1

struct PlaceDescriptor

Contains representations of a physical place, suitable for searching or retrieving rich data.

Members (8)

get · iOS 26.0+

commonName

TypeScript
get commonName(): (string) | null
Swift declaration
let commonName: String?

Publicly known name of the area or place of interest. Locations that do not have a public name (like a private residence) should be nil. e.g. "Starbucks" or "Yosemite National Park"

get · iOS 26.0+

coordinate

TypeScript
get coordinate(): ({ latitude: number; longitude: number }) | null
Swift declaration
var coordinate: CLLocationCoordinate2D? { get }

The latitude and longitude for a place.

get · iOS 26.4+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

init · iOS 26.0+

init

TypeScript
static init(representations: Array<PlaceDescriptor_PlaceRepresentation>, commonName?: (string) | null, supportingRepresentations?: Array<PlaceDescriptor_SupportingPlaceRepresentation>): PlaceDescriptor
Swift declaration
init(representations: [PlaceDescriptor.PlaceRepresentation], commonName: String?, supportingRepresentations: [PlaceDescriptor.SupportingPlaceRepresentation] = [])

Creates a PlaceDescriptor, suitable for searching or retrieving rich data about a place. Representations must have at least one member. Arrays should be sorted with original and/or most accurate representations first. - Parameters: - representations: A list of ways to reference the place using common mapping concepts. - commonName: Publicly known name of the area or place of interest. e.g. "Starbucks" - supportingRepresentations: List of ways to represent a place that are proprietary or non-uniform

get · iOS 26.0+

representations

TypeScript
get representations(): Array<PlaceDescriptor_PlaceRepresentation>
Swift declaration
let representations: [PlaceDescriptor.PlaceRepresentation]

An array of representations of the place using common mapping concepts When searching or fetching a place from a mapping service provider, the order of the list can be used as a hint. Representations that most closely match the original data source come first. For example a hike tracking app may include a `.coordinate` first, even if an approximate `.address` is available. A contacts application may put `.address` first, even if a `.coordinate` has been fetched for display on a Map.

method · iOS 26.0+

serviceIdentifier

TypeScript
serviceIdentifier(serviceProvider: string): (string) | null
Swift declaration
func serviceIdentifier(for serviceProvider: String) -> String?

Retrieve the identifier for a given service provider, if available.

get · iOS 26.0+

supportingRepresentations

TypeScript
get supportingRepresentations(): Array<PlaceDescriptor_SupportingPlaceRepresentation>
Swift declaration
let supportingRepresentations: [PlaceDescriptor.SupportingPlaceRepresentation]

An array of proprietary or non-uniform representations of the place. If understood by the consumer, these can be used in place of or in addition to common representations.

get · iOS 26.0+

address

TypeScript
get address(): (string) | null
Swift declaration
var address: String? { get }

Full address, as would be used in postal or administrative scenarios.

Skipped declarations

No declarations were skipped in this snapshot.

All GeoToolbox types →