MSFPeliasOnlineGeocodingService

Objective-C


@interface MSFPeliasOnlineGeocodingService : MSFGeocodingService

Swift

class MSFPeliasOnlineGeocodingService : MSFGeocodingService

An online geocoding service that uses Mapzen Pelias geocoder. As the class connects to an external (non-Massif) service, this class is provided “as-is”, future changes from the service provider may not be compatible with the implementation. Geocoding and reverse geocoding perform network requests and must be executed in non-UI background thread. Be sure to read the Terms and Conditions of your Pelias service provider to see if the service is available for your application. Note: this class is experimental and may change or even be removed in future SDK versions.

  • Constructs a new instance of the PeliasOnlineGeocodingService given API key.

    Declaration

    Objective-C

    - (id)initWithApiKey:(NSString *)apiKey;

    Swift

    init!(apiKey: String!)

    Parameters

    apiKey

    The API key to use (registered with Mapzen).

  • Returns the custom backend service URL.

    Declaration

    Objective-C

    - (NSString *)getCustomServiceURL;

    Swift

    func getCustomServiceURL() -> String!

    Return Value

    The custom backend service URL. If this is not defined, an empty string is returned.

  • Sets the custom backend service URL. The custom URL may contain tag “{api_key}” which will be substituted with the set API key. The custom URL should contain tag “{mode}” which will be set either to “autocomplete” or “search” based on the autocomplete state.

    Declaration

    Objective-C

    - (void)setCustomServiceURL:(NSString *)serviceURL;

    Swift

    func setCustomServiceURL(_ serviceURL: String!)

    Parameters

    serviceURL

    The custom backend service URL to use. If this is empty, then the default service is used.

  • Undocumented

    Declaration

    Objective-C

    - (BOOL)isAutocomplete;

    Swift

    func isAutocomplete() -> Bool
  • Undocumented

    Declaration

    Objective-C

    -(BOOL)isAutocompleteSwigExplicitMSFPeliasOnlineGeocodingService;

    Swift

    func isAutocompleteSwigExplicitMSFPeliasOnlineGeocodingService() -> Bool
  • Undocumented

    Declaration

    Objective-C

    - (void)setAutocomplete:(BOOL)autocomplete;

    Swift

    func setAutocomplete(_ autocomplete: Bool)
  • Undocumented

    Declaration

    Objective-C

    -(void)setAutocompleteSwigExplicitMSFPeliasOnlineGeocodingService: (BOOL)autocomplete;

    Swift

    func setAutocompleteSwigExplicit(_ autocomplete: Bool)
  • Undocumented

    Declaration

    Objective-C

    - (NSString *)getLanguage;

    Swift

    func getLanguage() -> String!
  • Undocumented

    Declaration

    Objective-C

    -(NSString*)getLanguageSwigExplicitMSFPeliasOnlineGeocodingService;

    Swift

    func getLanguageSwigExplicitMSFPeliasOnlineGeocodingService() -> String!
  • Undocumented

    Declaration

    Objective-C

    - (void)setLanguage:(NSString *)lang;

    Swift

    func setLanguage(_ lang: String!)
  • Undocumented

    Declaration

    Objective-C

    -(void)setLanguageSwigExplicitMSFPeliasOnlineGeocodingService: (NSString*)lang;

    Swift

    func setLanguageSwigExplicit(_ lang: String!)
  • Undocumented

    Declaration

    Objective-C

    - (int)getMaxResults;

    Swift

    func getMaxResults() -> Int32
  • Undocumented

    Declaration

    Objective-C

    -(int)getMaxResultsSwigExplicitMSFPeliasOnlineGeocodingService;

    Swift

    func getMaxResultsSwigExplicitMSFPeliasOnlineGeocodingService() -> Int32
  • Undocumented

    Declaration

    Objective-C

    - (void)setMaxResults:(int)maxResults;

    Swift

    func setMaxResults(_ maxResults: Int32)
  • Undocumented

    Declaration

    Objective-C

    -(void)setMaxResultsSwigExplicitMSFPeliasOnlineGeocodingService: (int)maxResults;

    Swift

    func setMaxResultsSwigExplicit(_ maxResults: Int32)
  • Undocumented

    Declaration

    Objective-C

    - (MSFGeocodingResultVector *)calculateAddresses:(MSFGeocodingRequest *)request;

    Swift

    func calculateAddresses(_ request: MSFGeocodingRequest!) -> MSFGeocodingResultVector!
  • Undocumented

    Declaration

    Objective-C

    -(MSFGeocodingResultVector*)calculateAddressesSwigExplicitMSFPeliasOnlineGeocodingService: (MSFGeocodingRequest*)request;

    Swift

    func calculateAddressesSwigExplicitMSFPeliasOnlineGeocodingService(_ request: MSFGeocodingRequest!) -> MSFGeocodingResultVector!
  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()