HERE iOS SDK Developer's Guide

NMA Search

Group Summary

group NMA Search

The Search group provides classes, protocols, and enumerations for performing place and geocoder searches.

[For complete information, see the section Group Details]

Nested Classes

Public Typedef Summary

Table 2. Public Typedefs
Public Typedefs

(void) (^NMAPlacesCategoriesCompletionBlock) (NSArray< NMACategory * > *_Nullable categories, NSError *_Nullable error)

A typedef of a block parameter signature used with NMAPlaces::refreshTopLevelCategoriesWithCompletion:.

(void) (^NMARequestCompletionBlock) (NMARequest *_Nonnull request, id _Nullable data, NSError *_Nullable error)

A typedef of a block parameter signature used with NMARequest::startWithBlock:.

Public Enumeration Summary

Table 3. Public Enumerations
Public Enumerations

NMAAutoSuggestType

Represents available NMAAutoSuggest derived objects.

NMACategoryFilterType

Defines types of categories filter.

NMAMediaType

Represents available NMAMedia derived objects.

NMAPlacesAutoSuggestionResultType

Represents values describing AutoSuggestion response's result types that can be used to restrict the AutoSuggestion response.

NMARequestConnectivity

The possible types of connectivity mode that the request is performed.

NMATextFormat

Search result text output formats.

Public Variable Summary

Table 4. Public Variables
Public Variables

FOUNDATION_EXPORT NSString *const _Nonnull  NMADeparturePlatformKeyName

Key name to retrieve the departure platform information.

FOUNDATION_EXPORT NSString *const _Nonnull  NMADepartureTimeKeyName

Key name to retrieve departure time.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAExceptionEventAdditional

Additional departure information provided.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAExceptionEventCancelled

Departure has been cancelled.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAExceptionEventRedirected

Departure has been redirected.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAExceptionEventReplaced

Departure has been replaced.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourceBuilding

Places Reference Source for building IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourcePVID

Places Reference Source for core POI IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourceSharing

Places Reference Source for sharing IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourceVenuesAll

Places Reference Source for all types of venue IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourceVenuesContent

Places Reference Source for venue content IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourceVenuesDestination

Places Reference Source for venue destination IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPlacesSourceVenuesVenue

Places Reference Source for venue IDs.

FOUNDATION_EXPORT NSString *const _Nonnull  NMATransitDeparturesExtendedAttributeId

Constant that defines the public transit departures extended identifier

FOUNDATION_EXPORT NSString *const _Nonnull  NMATransitLinesExtendedAttributeId

Constant that defines the public transit lines extended identifier

FOUNDATION_EXPORT NSString *const _Nonnull  NMA_PLACES_ERROR_DOMAIN

Group Details

The Search group provides classes, protocols, and enumerations for performing place and geocoder searches. Some important classes in this group are NMAPlaces and NMAGeocoder.

Public Typedef Details

(void) (^NMAPlacesCategoriesCompletionBlock) (NSArray< NMACategory * > *_Nullable categories, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAPlaces.h

A typedef of a block parameter signature used with NMAPlaces::refreshTopLevelCategoriesWithCompletion:.

Note:

The block will be called on the main queue.

Parameters:

  • categories

    An NSArray of localized NMACategory if available, nil otherwise.

  • error

    The error if the refresh failed, or nil if the refresh was successful.

See also:

NMAPlaces::refreshTopLevelCategoriesWithCompletion:

(void) (^NMARequestCompletionBlock) (NMARequest *_Nonnull request, id _Nullable data, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMARequest.h

A typedef of a block parameter signature used with NMARequest::startWithBlock:.

The following table shows corresponding request and result types.
Note:

The block will be called on the main queue.

Parameters:

  • request

    The search request being completed.

  • data

    Search results. Search result type varies according to the search request initiated. It can be nil if no results are found or an error is encountered.

  • error

    The error if the request failed, or nil if the request was successful.

See also:

NMARequest::startWithBlock:

NMASearchResultType

Public Enumeration Details

NMAAutoSuggestType

Include: NMAKit.framework/headers/NMAAutoSuggest.h

Represents available NMAAutoSuggest derived objects.

Enumeration Members:

  • NMAAutoSuggestTypeUnknown

    NMAAutoSuggest object unknown.

  • NMAAutoSuggestTypePlace

    A link to a suggested place.

  • NMAAutoSuggestTypeSearch

    A link to a suggested search.

  • NMAAutoSuggestTypeQuery

    A link to a suggested query.

NMACategoryFilterType

Include: NMAKit.framework/headers/NMACategoryFilter.h

Defines types of categories filter.

Enumeration Members:

  • NMACategoryFilterTypeNone

    No category.

  • NMACategoryFilterTypeAccommodation

    The accommodation category.

  • NMACategoryFilterTypeAdministrativeAreasBuildings

    The administrative-areas-buildings category.

  • NMACategoryFilterTypeEatDrink

    The eat-drink category.

  • NMACategoryFilterTypeGoingOut

    The going-out category.

  • NMACategoryFilterTypeLeisureOutdoor

    The leisure-outdoor category.

  • NMACategoryFilterTypeNaturalGeographical

    The natural-geographical category.

  • NMACategoryFilterTypeShopping

    The shopping category.

  • NMACategoryFilterTypeSightsMuseums

    The sights-museums category.

  • NMACategoryFilterTypeTransport

    The transport category.

  • NMACategoryFilterTypePetrolStation

    The petrol-station category.

  • NMACategoryFilterTypeAtmBankExchange

    The atm-bank-exchange category.

  • NMACategoryFilterTypeToiletRestArea

    The toilet-rest-area category.

  • NMACategoryFilterTypeHospitalHealthCareFacility

    The hospital-health-care-facility category.

NMAMediaType

Include: NMAKit.framework/headers/NMAMedia.h

Represents available NMAMedia derived objects.

Enumeration Members:

NMAPlacesAutoSuggestionResultType

Include: NMAKit.framework/headers/NMAPlaces.h

Represents values describing AutoSuggestion response's result types that can be used to restrict the AutoSuggestion response.

Enumeration Members:

  • NMAPlacesAutoSuggestionResultAddress

    AutoSuggestion response will contain Location and address suggestion result type

  • NMAPlacesAutoSuggestionResultPlace

    AutoSuggestion response will contain POI suggestion result type

  • NMAPlacesAutoSuggestionResultCategory

    AutoSuggestion response will contain Category search suggestion result type

  • NMAPlacesAutoSuggestionResultChain

    AutoSuggestion response will contain Chain/Brand search suggestion result type

  • NMAPlacesAutoSuggestionResultQuery

    AutoSuggestion response will contain Query completion suggestion result type

NMARequestConnectivity

Include: NMAKit.framework/headers/NMARequest.h

The possible types of connectivity mode that the request is performed.

Enumeration Members:

  • NMARequestConnectivityDefault

    The request will be executed based on the current online status [ NMAApplicationContext isOnline], which depends on the current network access and could be forced to offline using [ NMAApplicationContext setNetworkAccessAllowed:NO]. If the SDK is online then an online request will be made. If the SDK is offline then an offline request will be made.

  • NMARequestConnectivityOffline

    The request will be executed in offline mode regardless whether there is enough map data on the device. If there is not enough map data the request might fail or return zero results. If it fails, it will not try online.

  • NMARequestConnectivityOnline

    The request will be executed in online mode regardless whether the current online status [ NMAApplicationContext isOnline] is online or not. If offline the request will fail. If it fails, it will not try offline.

NMATextFormat

Include: NMAKit.framework/headers/NMARequest.h

Search result text output formats.

Enumeration Members:

  • NMATextFormatHTML

    The request results will be rendered as HTML.

  • NMATextFormatPlain

    The request results will be rendered as plain text.

Public Variable Details

FOUNDATION_EXPORT NSString *const _Nonnull NMADeparturePlatformKeyName

Include: NMAKit.framework/headers/NMAPlaceTransitDeparture.h

Key name to retrieve the departure platform information.

FOUNDATION_EXPORT NSString *const _Nonnull NMADepartureTimeKeyName

Include: NMAKit.framework/headers/NMAPlaceTransitDeparture.h

Key name to retrieve departure time.

FOUNDATION_EXPORT NSString *const _Nonnull NMAExceptionEventAdditional

Include: NMAKit.framework/headers/NMAPlaceTransitDeparture.h

Additional departure information provided.

FOUNDATION_EXPORT NSString *const _Nonnull NMAExceptionEventCancelled

Include: NMAKit.framework/headers/NMAPlaceTransitDeparture.h

Departure has been cancelled.

FOUNDATION_EXPORT NSString *const _Nonnull NMAExceptionEventRedirected

Include: NMAKit.framework/headers/NMAPlaceTransitDeparture.h

Departure has been redirected.

FOUNDATION_EXPORT NSString *const _Nonnull NMAExceptionEventReplaced

Include: NMAKit.framework/headers/NMAPlaceTransitDeparture.h

Departure has been replaced.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourceBuilding

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for building IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourcePVID

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for core POI IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourceSharing

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for sharing IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourceVenuesAll

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for all types of venue IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourceVenuesContent

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for venue content IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourceVenuesDestination

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for venue destination IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPlacesSourceVenuesVenue

Include: NMAKit.framework/headers/NMAPlaces.h

Places Reference Source for venue IDs.

FOUNDATION_EXPORT NSString *const _Nonnull NMATransitDeparturesExtendedAttributeId

Include: NMAKit.framework/headers/NMAExtendedAttribute.h

Constant that defines the public transit departures extended identifier.

FOUNDATION_EXPORT NSString *const _Nonnull NMATransitLinesExtendedAttributeId

Include: NMAKit.framework/headers/NMAExtendedAttribute.h

Constant that defines the public transit lines extended identifier.

FOUNDATION_EXPORT NSString *const _Nonnull NMA_PLACES_ERROR_DOMAIN

Include: NMAKit.framework/headers/NMAResultListener.h

Defines the name for Places API error domain

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.