HereSDKAddressData

@interface HereSDKAddressData : NSObject

Data object that represents detailed data about an address.

  • The country name

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *country;

    Swift

    var country: String? { get }
  • The ISO 3166 Alpha 3 country code

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *countryCode;

    Swift

    var countryCode: String? { get }
  • first subdivision level below the country

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *state;

    Swift

    var state: String? { get }
  • second subdivision level below the country

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *county;

    Swift

    var county: String? { get }
  • The city

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *city;

    Swift

    var city: String? { get }
  • subdivision level below the city

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *district;

    Swift

    var district: String? { get }
  • subdivision level below the district. commonly used in IND

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *subDistrict;

    Swift

    var subDistrict: String? { get }
  • The street name

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *street;

    Swift

    var street: String? { get }
  • house number. depending on regional characteristics, can also be house name

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *houseNumber;

    Swift

    var houseNumber: String? { get }
  • The postal code

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *postalCode;

    Swift

    var postalCode: String? { get }
  • building name. commonly used in HKG

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *building;

    Swift

    var building: String? { get }
  • formatted address lines

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSArray<NSString *> *lineArray;

    Swift

    var lineArray: [String]? { get }
  • Initializes and returns HereSDKAddressData

    Declaration

    Objective-C

    + (nonnull instancetype)addressDataWithCountry:(NSString *_Nullable)country
                                       countryCode:(NSString *_Nullable)countryCode
                                             state:(NSString *_Nullable)state
                                            county:(NSString *_Nullable)county
                                              city:(NSString *_Nullable)city
                                          district:(NSString *_Nullable)district
                                       subDistrict:(NSString *_Nullable)subDistrict
                                            street:(NSString *_Nullable)street
                                       houseNumber:(NSString *_Nullable)houseNumber
                                        postalCode:(NSString *_Nullable)postalCode
                                          building:(NSString *_Nullable)building
                                         lineArray:(nonnull NSArray<NSString *> *)
                                                       lineArray;

    Swift

    convenience init(country: String?, countryCode: String?, state: String?, county: String?, city: String?, district: String?, subDistrict: String?, street: String?, houseNumber: String?, postalCode: String?, building: String?, lineArray: [String])

    Parameters

    country

    localized country name value

    countryCode

    ISO 3166-alpha-3 country code value

    state

    first subdivision level below the country

    county

    second subdivision level below the country

    city

    primary locality of the address

    district

    subdivision level below the city

    subDistrict

    subdivision level below the district. commonly used in IND

    street

    street name

    houseNumber

    house number. depending on regional characteristics, can also be house name

    postalCode

    postal code

    building

    building name. commonly used in HKG

    lineArray

    formatted address lines

    Return Value

    the HereSDKAddressData with passed parameters