HERE iOS SDK Developer's Guide

NMA Custom Location Extension 2

Group Summary

group NMA Custom Location Extension 2

The Custom Location Extensions 2 group provides classes and protocols that support advanced custom location searches.

[For complete information, see the section Group Details]

Nested Classes

Public Typedef Summary

Table 2. Public Typedefs
Public Typedefs

(void) (^NMACLE2LayerDownloadCompletionBlock) (NSString *layerId, NSError *__nullable error)

A typedef of a block parameter signature used with NMACLE2DataManagercompletionHandler:::downloadLayer:completionHandler:.

(void) (^NMACLE2RequestCompletionBlock) (NMACLE2Request *request, NMACLE2Result *result, NSError *__nullable error)

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

Public Enumeration Summary

Table 3. Public Enumerations
Public Enumerations

NMACLE2ConnectivityMode

Specifies the request mode

NMACLE2Error

The possible NMACLE2Request error codes.

NMACLE2GeometryType

Specifies the geometry representation in the result.

Public Property Summary

Table 4. Public Properties
Public Properties

[readable, assign] NSDictionary< NSString *, NSString * > *  attributes

Returns NSDictionary with the available attributes for this geometry

Public Variable Summary

Table 5. Public Variables
Public Variables

FOUNDATION_EXPORT NSString *const  kNMACLE2ErrorDomain

The error domain for NMACLE2Request

Group Details

The Custom Location Extensions 2 group provides classes and protocols that support advanced custom location searches.

Public Typedef Details

(void) (^NMACLE2LayerDownloadCompletionBlock) (NSString *layerId, NSError *__nullable error)

Include: NMAKit.framework/headers/NMACLE2DataManager.h

A typedef of a block parameter signature used with NMACLE2DataManagercompletionHandler:::downloadLayer:completionHandler:.

The block will be called on the main queue.

Parameters:

  • layerId

    The id of a layer being downloaded.

  • error

    The error if the download failed, or nil if it was successful.

(void) (^NMACLE2RequestCompletionBlock) (NMACLE2Request *request, NMACLE2Result *result, NSError *__nullable error)

Include: NMAKit.framework/headers/NMACLE2Request.h

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

Note:

The block will be called on the main queue.

Parameters:

  • request

    The search request being completed.

  • result

    The search results. 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.

Public Enumeration Details

NMACLE2ConnectivityMode

Include: NMAKit.framework/headers/NMACLE2Request.h

Specifies the request mode

NMACLE2ConnectivityModeOnline: Local storage will not be considered at all; Default behaviour. NMACLE2ConnectivityModeOffline: Use local storage only NMACLE2ConnectivityModeAutomatic: Attemps online and falls back to offline if failed.

Note:

By default, the offline features are disabled therefore the local storage contains no data. There are two ways to insert geometries in local storage to make them available for offline searches: 1 - Enable caching when performing one or more requests (e.g., using the NMACLE2ProximityRequest). 2 - Download one or more layers.

Enumeration Members:

  • NMACLE2ConnectivityModeOnline  
  • NMACLE2ConnectivityModeOffline  
  • NMACLE2ConnectivityModeAutomatic  

NMACLE2Error

Include: NMAKit.framework/headers/NMACLE2Request.h

The possible NMACLE2Request error codes.

Enumeration Members:

  • NMACLE2ErrorNone  
  • NMACLE2ErrorInvalidParameter  
  • NMACLE2ErrorInProgress  
  • NMACLE2ErrorCancelled  
  • NMACLE2ErrorNetworkCommunication  
  • NMACLE2ErrorOperationNotAllowed  
  • NMACLE2ErrorDataManagerFailed  
  • NMACLE2ErrorServerFailed  
  • NMACLE2ErrorPartialSuccess  
  • NMACLE2ErrorUnknown  

NMACLE2GeometryType

Include: NMAKit.framework/headers/NMACLE2Request.h

Specifies the geometry representation in the result.

Note:

When a geometry is uploaded to CLE, they are tiled for fast look-up. This property allows specifying whether the original uploaded geometry is required (NMACLE2GeometryFull), or the if the geometry whithin the tile is sufficient (NMACLE2GeometryLocal), or if no geometry information is needed at all (NMACLE2GeometryNone). The later would be the use-case where it is only interesting to know whether a geometry falls within the specified search, and if results are found, what are its attributes (without retrieving the geometry information itself).

Enumeration Members:

  • NMACLE2GeometryFull  
  • NMACLE2GeometryLocal  
  • NMACLE2GeometryNone  

Public Property Details

[readable, assign] NSDictionary< NSString *, NSString * > * attributes

Include: NMAKit.framework/headers/NMACLE2Geometry.h

Returns NSDictionary with the available attributes for this geometry. The keys represent the customer fields, with their respective values.

Note:

All keys and values are of NSString type.

Public Variable Details

FOUNDATION_EXPORT NSString *const kNMACLE2ErrorDomain

Include: NMAKit.framework/headers/NMACLE2Request.h

The error domain for NMACLE2Request.

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.