Address

public struct Address : Equatable

A collection of information that describes geographical location

Lifecycle


                    
                    
                    init(streetNumber:streetName:municipalitySubdivision:municipality:countrySecondarySubdivision:countryTertiarySubdivision:countrySubdivisionCode:countrySubdivisionName:postalCode:extendedPostalCode:countryCode:country:countryCodeISO3:freeformAddress:localName:streetNameAndNumber:postalName:neighborhoodName:)

Creates an instance of Address.

Declaration

Swift

public init(
    streetNumber: String? = nil,
    streetName: String? = nil,
    municipalitySubdivision: String? = nil,
    municipality: String? = nil,
    countrySecondarySubdivision: String? = nil,
    countryTertiarySubdivision: String? = nil,
    countrySubdivisionCode: String? = nil,
    countrySubdivisionName: String? = nil,
    postalCode: String? = nil,
    extendedPostalCode: String? = nil,
    countryCode: String? = nil,
    country: String? = nil,
    countryCodeISO3: String? = nil,
    freeformAddress: String? = nil,
    localName: String? = nil,
    streetNameAndNumber: String? = nil,
    postalName: String? = nil,
    neighborhoodName: String? = nil
)

Public

streetNumber
The building number on the street, such as “33” or “221B”.
Declaration
Swift

public let streetNumber: String?
streetName
The name of the street.
Declaration
Swift

public let streetName: String?
municipalitySubdivision
Subdivision level of locality. Can be a neighborhood, suburb, city, district, village, etc.
Declaration
Swift

public let municipalitySubdivision: String?
municipality
Locality. Can be a city, town, community, etc. For example: “San Jose”.
Declaration
Swift

public let municipality: String?
countrySecondarySubdivision
Second level of country administrative hierarchy. Can be a county, borough, parish, municipality, etc. For example: “Santa Clara”.
Declaration
Swift

public let countrySecondarySubdivision: String?
countryTertiarySubdivision
Third level of country subdivision.
Declaration
Swift

public let countryTertiarySubdivision: String?
countrySubdivisionCode
The code of the first level of country administrative hierarchy. Can be a state, province, region, dependent country, etc. For example: “CA”.
Declaration
Swift

public let countrySubdivisionCode: String?
countrySubdivisionName
The full name of the first level of a country administrative hierarchy. This field only appears in case countrySubdivision is presented in an abbreviated form. Supported only for USA, Canada, and Great Britain.
Declaration
Swift

public let countrySubdivisionName: String?
postalCode
Postal(Zip) code. For example: “95113”.
Declaration
Swift

public let postalCode: String?
extendedPostalCode
Extended postal code. For example: “95113-1002”.
Declaration
Swift

public let extendedPostalCode: String?
countryCode
Two-letter country code in ISO 3166-1 alpha2 standard. For example: “US”.
Declaration
Swift

public let countryCode: String?
country
Full name of a country. For example: “United States Of America”.
Declaration
Swift

public let country: String?
countryCodeISO3
Three-letter country code in ISO 3166-1 alpha3 standard. For example: “USA”.
Declaration
Swift

public let countryCodeISO3: String?
freeformAddress
Free-form address, For example: “33 S lst St, San Jose, CA 95113”.
Declaration
Swift

public let freeformAddress: String?
localName
Local name.
Declaration
Swift

public let localName: String?
streetNameAndNumber
The text containing both street name and number.
Declaration
Swift

public let streetNameAndNumber: String?
postalName
The local name.
Declaration
Swift

public let postalName: String?
neighborhoodName
The name of the neighborhood.
Declaration
Swift

public let neighborhoodName: String?