Class YMKSearchAddress

Contains structured address, formatted address, postal code and country code.

Structured address is an ordered list of components (usually administrative hierarchy). Formatted address is a full address as a single string. Formatted address generally can't be obtained from component names. Some components could be ignored (large administrative region) or absent (office number).

Class Methods

Properties

additionalInfo

Additional address info.

components

Address component list, see YMKSearchAddressComponent, may be empty.

countryCode

Country code in ISO 3166-1 alpha-2 format (two-letter country code).

formattedAddress

Human-readable address.

postalCode

Postal/Zip code.

Method Detail

+addressWithFormattedAddress:additionalInfo:postalCode:countryCode:components:

+ (nonnull YMKSearchAddress *)addressWithFormattedAddress:(nonnull NSString *)formattedAddress
                                           additionalInfo:(nullable NSString *)additionalInfo
                                               postalCode:(nullable NSString *)postalCode
                                              countryCode:(nullable NSString *)countryCode
                                               components:(nonnull NSArray< YMKSearchAddressComponent * > *)components 

Property Detail

additionalInfo

(assign, readonly) NSString * additionalInfo

Additional address info.

Optional property, can be null.

components

(assign, readonly) NSArray< YMKSearchAddressComponent * > * components

Address component list, see YMKSearchAddressComponent, may be empty.

countryCode

(assign, readonly) NSString * countryCode

Country code in ISO 3166-1 alpha-2 format (two-letter country code).

Optional property, can be null.

formattedAddress

(assign, readonly) NSString * formattedAddress

Human-readable address.

postalCode

(assign, readonly) NSString * postalCode

Postal/Zip code.

Optional property, can be null.