Address

public struct Address : Hashable

Information about the address of a location.

Used in Place.address.

Note that while OfflineSearchEngine.suggest and OfflineSearchEngine.suggestByText set all available details, SearchEngine.suggest and SearchEngine.suggestByText set only Address.addressText. Complete address details can be obtained by searching with PlaceIdQuery.

  • The city name for the address, for example, “Brooklyn”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var city: String

  • An ISO-3166-1 (3-letter) country code for the address, for example, “USA”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var countryCode: String

  • The country name for the address, for example, “United States”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var country: String

  • The district name for the address. It is a division of city, typically an administrative unit within a larger city or a customary name of a city’s neighborhood, for example, “Bedford-Stuyvesant”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var district: String

  • The subdistrict name for the address. It is a subdivision of a district. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var subdistrict: String

  • The house name or number for the address, for example, “347”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var houseNumOrName: String

  • The postal code for the address. It is an alphanumeric string included in a postal address to facilitate mail sorting, known locally in various countries throughout the world as a postcode, post code, PIN or ZIP Code, for example, “11233”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var postalCode: String

  • The state name for the address. It is the name of the state division of a country, for example, “New York”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var state: String

  • The county name for the address. It is a division of a state, typically a secondary-level administrative division of a country or equivalent, for example, “Kings”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var county: String

  • The street name for the address, for example, “Lewis Ave”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var street: String

  • The block number for the address. It is part of Japanese addressing system. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var block: String

  • The sub-block number for the address. It is part of Japanese addressing system. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var subBlock: String

  • The text for the address, for example, “Secret Garden, 347 Lewis Ave, Brooklyn, NY 11233, United States”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var addressText: String

  • Specifies the address type.

    Declaration

    Swift

    public var type: AddressType?

  • The state code for the address. It is code/abbreviation of the state division of a country, for example, “NY”. Note: This String can be empty when no data is available.

    Declaration

    Swift

    public var stateCode: String

  • Undocumented

    Declaration

    Swift

    public init(city: String = "", countryCode: String = "", country: String = "", district: String = "", subdistrict: String = "", houseNumOrName: String = "", postalCode: String = "", state: String = "", county: String = "", street: String = "", block: String = "", subBlock: String = "", addressText: String = "", type: AddressType? = nil, stateCode: String = "")