HERE iOS SDK Developer's Guide

NMACustomLocationManager

Class Summary

class NMACustomLocationManager

Derived from: NSObject

A singleton class used to perform search requests for custom locations.

Deprecated: This class is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

Include: NMAKit.framework/headers/NMACustomLocationManager.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMACustomLocationManager

[For complete information, see the section Class Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

-(void) requestGeometriesInGeoBoundingBox:( NMAGeoBoundingBox *) boundingBox withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2BoundingBoxRequest in CLE2.

Requests for custom geometries that are inside a geo bounding box

-(void) requestGeometriesIntersectingCoordinates:( NMAGeoCoordinates *) geoCoordinates withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2ProximityRequest in CLE2.

Requests for custom geometries that intersect with the given geo coordinates

-(void) requestGeometryWithId:(NSUInteger) geometryId withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2AttributeRequest in CLE2.

Requests for a custom geometry with the specified id

-(void) requestLocationsAlongCorridor:(NSArray *) corridor withRadius:(NSUInteger) radius layer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This method is replaced by NMACLE2CorridorRequest in CLE2.

Requests for custom locations along a geo corridor

-(void) requestLocationsInGeoBoundingBox:( NMAGeoBoundingBox *) boundingBox withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This method is replaced by NMACLE2BoundingBoxRequest in CLE2.

Requests for custom locations inside a geo bounding box

-(void) requestLocationsNearGeoCoordinates:( NMAGeoCoordinates *) coordinates withRadius:(NSUInteger) radius layer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This method is replaced by NMACLE2ProximityRequest in CLE2.

Requests for custom locations near a pair of geo coordinates

-(void) requestLocationsOnRoute:( NMARoute *) route withRadius:(NSUInteger) radius layer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2CorridorRequest in CLE2.

Requests for custom locations along a route

-(void) requestLocationsWithLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2AttributeRequest in CLE2.

Requests for custom locations that are on a given layer

Class Method Summary

Table 2. Class Methods
Class Methods

+(instancetype) sharedLocationManager

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. In CLE2, there's no need to have a manager to perform requests. Such task can be done directly in the respective NMACLE2Request.

Provides access to the singleton instance of NMACustomLocationManager

Class Details

A singleton class used to perform search requests for custom locations.

Using the Custom Location Extension, client applications may provide their own sets of custom place locations to the Here SDK back end. Then, using the CLE SDK classes, the application may search for and retrieve these custom locations, which can then be used to supplement the places provided by standard Here searches, or for any other purpose required by the application.

The NMACustomLocationManager provides several methods for requesting custom locations. Locations may be searched around a posiiton, inside a bounding box, along a route, and more. Additional search parameters may be provided to filter the results, including a layer ID, search radius, text query, and custom attributes.

The results of search requests are packaged in an NMACustomLocationResponse object, which is passed to the completion block provided to the request method. If there is an error with the request, a request object is also passed to the completion block. Requests are performed asynchronously, and may be executed simultaneously.

Deprecated: This class is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

Instance Method Details

-(void) requestGeometriesInGeoBoundingBox:( NMAGeoBoundingBox *) boundingBox withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2BoundingBoxRequest in CLE2.

Requests for custom geometries that are inside a geo bounding box.

Parameters:

  • boundingBox

    The NMAGeoBoundingBox inside which the search should be performed.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

-(void) requestGeometriesIntersectingCoordinates:( NMAGeoCoordinates *) geoCoordinates withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2ProximityRequest in CLE2.

Requests for custom geometries that intersect with the given geo coordinates.

Parameters:

  • geoCoordinates

    The NMAGeoCoordinates against which the intersection should be checked.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

-(void) requestGeometryWithId:(NSUInteger) geometryId withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2AttributeRequest in CLE2.

Requests for a custom geometry with the specified id.

Parameters:

  • geometryId

    The id of the requested geometry.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

-(void) requestLocationsAlongCorridor:(NSArray *) corridor withRadius:(NSUInteger) radius layer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This method is replaced by NMACLE2CorridorRequest in CLE2.

Requests for custom locations along a geo corridor.

A geo corridor is a series of one or more geo coordinates representing a path in the world. For example, a corridor can be used to find locations along a given street between two intersections (if the coordinates of the intersections are known).

Parameters:

  • corridor

    The corridor along which to perform the search.

  • radius

    The radius of the search area in meters.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

-(void) requestLocationsInGeoBoundingBox:( NMAGeoBoundingBox *) boundingBox withLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This method is replaced by NMACLE2BoundingBoxRequest in CLE2.

Requests for custom locations inside a geo bounding box.

Parameters:

  • boundingBox

    The bounding box inside which to perform the search.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

-(void) requestLocationsNearGeoCoordinates:( NMAGeoCoordinates *) coordinates withRadius:(NSUInteger) radius layer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This method is replaced by NMACLE2ProximityRequest in CLE2.

Requests for custom locations near a pair of geo coordinates.

Parameters:

  • coordinates

    The coordinates around which to perform the search.

  • radius

    The radius of the search area in meters.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

See also:

NMACustomLocationParameters

-(void) requestLocationsOnRoute:( NMARoute *) route withRadius:(NSUInteger) radius layer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2CorridorRequest in CLE2.

Requests for custom locations along a route.

Parameters:

  • route

    The route on which to perform the search.

  • radius

    The radius of the search area in meters.

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

-(void) requestLocationsWithLayer:(NSUInteger) layerID parameters:( NMACustomLocationParameters *) parameters completion:( NMACustomLocationCompletionBlock ) completion

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. This functionality is replaced by NMACLE2AttributeRequest in CLE2.

Requests for custom locations that are on a given layer.

Parameters:

  • layerID

    The layer in which to search.

  • parameters

    Optional parameters to filter the search results. If nil is passed, a default search is performed.

  • completion

    The completion block to handle the results of the request.

Class Method Details

+(instancetype) sharedLocationManager

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2 instead. In CLE2, there's no need to have a manager to perform requests. Such task can be done directly in the respective NMACLE2Request.

Provides access to the singleton instance of NMACustomLocationManager.

Note:

This method returns a nil object if access to this operation is denied. Contact your HERE representative for more information.

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.