MSFGeocodingService

Objective-C


@interface MSFGeocodingService : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFGeocodingService : NSObject

An abstract base class for geocoding services.

  • Returns the autocomplete flag of the service.

    Declaration

    Objective-C

    - (BOOL)isAutocomplete;

    Swift

    func isAutocomplete() -> Bool

    Return Value

    The autocomplete flag of the service.

  • Sets the autocomplete flag of the service. By default this flag is off.

    Declaration

    Objective-C

    - (void)setAutocomplete:(BOOL)autocomplete;

    Swift

    func setAutocomplete(_ autocomplete: Bool)

    Parameters

    autocomplete

    The new value for autocomplete flag.

  • Returns the language of the expected results.

    Declaration

    Objective-C

    - (NSString *)getLanguage;

    Swift

    func getLanguage() -> String!

    Return Value

    The language of the expected results. As ISO 639-1 code or empty string.

  • Sets the language of the expected results.

    Declaration

    Objective-C

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

    Swift

    func setLanguage(_ lang: String!)

    Parameters

    lang

    The language to use as ISO 639-1 code. Empty string can be used for default language.

  • Returns the maximum number of results the geocoding service returns.

    Declaration

    Objective-C

    - (int)getMaxResults;

    Swift

    func getMaxResults() -> Int32

    Return Value

    The maximum number of results the geocoding service returns.

  • Sets the maximum number of results the geocoding service returns. The default number of results is service dependant (normally 10).

    Declaration

    Objective-C

    - (void)setMaxResults:(int)maxResults;

    Swift

    func setMaxResults(_ maxResults: Int32)

    Parameters

    maxResults

    The new maximum number of results the geocoding service returns.

  • Calculates matching addresses from the specified geocoding request.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

    The geocoding request to use.

    Return Value

    The list of matching geocoding results, sorted by descending ranks. @throws NSException If IO error occured during the calculation.

  • The default constructor.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()