HERE iOS SDK Developer's Guide

NMA Common

Group Summary

group NMA Common

The Common group includes classes, protocols, and enumerations that are generally used by other packages in the iOS SDK.

[For complete information, see the section Group Details]

Nested Classes

Public Enumeration Summary

Table 2. Public Enumerations
Public Enumerations

NMALayoutPosition

Represents fixed locations or regions within a bounding rectangle.

NMARequestError

Error codes that may be returned from places search requests.

NMARoadElementAttribute

Attributes of a road element.

NMARoadElementPluralType

Plural type identifies when a Junction is made up of multiple Road Elements. It also implies that a maneuver may require different explication than implied by the geometry.

NMARoadElementType

Road element classifications.

Public Variable Summary

Table 3. Public Variables
Public Variables

const double  NMAGeoPositionUnknownValue

A constant used to indicate an unknown measurement value

FOUNDATION_EXPORT const NSUInteger  NMAMapObjectMaximumZIndex

FOUNDATION_EXPORT const NSUInteger  NMAMapObjectMinimumZIndex

FOUNDATION_EXPORT const float  NMAMapViewMaximumZoomLevel

Upper limit of the NMAMapView zoomLevel property

FOUNDATION_EXPORT const float  NMAMapViewMinimumZoomLevel

Lower limit of the NMAMapView zoomLevel property

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPositioningManagerDidLosePositionNotification

Indicates that the NMAPositioningManager currentPosition has been lost.

FOUNDATION_EXPORT NSString *const _Nonnull  NMAPositioningManagerDidUpdatePositionNotification

Indicates that the NMAPositioningManager currentPosition has changed.

Group Details

The Common group includes classes, protocols, and enumerations that are generally used by other packages in the iOS SDK. Some important classes in this group are NMAGeoCoordinates and NMAPositioningManager.

Public Enumeration Details

NMALayoutPosition

Include: NMAKit.framework/headers/NMATypes.h

Represents fixed locations or regions within a bounding rectangle.

Enumeration Members:

  • NMALayoutPositionTopLeft  
  • NMALayoutPositionTopCenter  
  • NMALayoutPositionTopRight  
  • NMALayoutPositionCenterLeft  
  • NMALayoutPositionCenter  
  • NMALayoutPositionCenterRight  
  • NMALayoutPositionBottomLeft  
  • NMALayoutPositionBottomCenter  
  • NMALayoutPositionBottomRight  

NMARequestError

Include: NMAKit.framework/headers/NMATypes.h

Error codes that may be returned from places search requests.

Enumeration Members:

  • NMARequestErrorNone

    No error.

  • NMARequestErrorUnknown

    Unknown error.

  • NMARequestErrorAddressMissing

    Request is missing an address parameter.

  • NMARequestErrorLocationContextInvalid

    Location context is invalid.

  • NMARequestErrorLocationContextMissing

    Request is missing location context parameter.

  • NMARequestErrorCountryCodeMissing

    Request is missing a country code in the address parameter.

  • NMARequestErrorSearchTextMissing

    Request missing search text parameter.

  • NMARequestErrorInvalidParameter

    Invalid query parameter.

  • NMARequestErrorNetworkCommunication

    Network communications error.

  • NMARequestErrorNetworkServer

    Backend server unreachable.

  • NMARequestErrorNetworkEmptyInput

    Request input missing.

  • NMARequestErrorInvalidCredentials

    Application ID and/or token are missing or invalid.

  • NMARequestErrorHttp

    Request failed due to an HTTP error.

  • NMARequestErrorNetworkUnknown

    Unknown network error.

  • NMARequestErrorNotSupported

    Functionality not supported.

  • NMARequestErrorNotReady

    An entity is not ready. All poll functions return this when one needs to poll again. Also if an operation is in progress.

  • NMARequestErrorNotFound

    When something was not found.

  • NMARequestErrorAlreadyExists

    When resource already exists.

  • NMARequestErrorOutOfMemory

    Out of memory.

  • NMARequestErrorOperationFailed

    When operation fails (e.g.extracting of file failed)

  • NMARequestErrorAborted

    Operation aborted by user.

  • NMARequestErrorFinderIndexFailure

    Search index failure.

  • NMARequestErrorMovedPermanently

    Resource moved (e.g. resource URI changed)

  • NMARequestErrorNotModified

    Resource contend remains the same.

  • NMARequestErrorBadRequest

    Invalid request (places component might need to be updated)

  • NMARequestErrorResourceGone

    Resource no longer exists.

  • NMARequestErrorParse

    An error occured during document parsing (json, etc.)

  • NMARequestErrorTimeout

    Request timeout.

NMARoadElementAttribute

Include: NMAKit.framework/headers/NMARoadElement.h

Attributes of a road element.

Enumeration Members:

  • NMARoadElementAttributeUndefined  
  • NMARoadElementAttributeDirtRoad

    Road type.

  • NMARoadElementAttributeUsageFeeRequired  
  • NMARoadElementAttributeCarpool  
  • NMARoadElementAttributeUrban  
  • NMARoadElementAttributeTollroad  
  • NMARoadElementAttributeNoThroughTraffic  
  • NMARoadElementAttributeTunnel  
  • NMARoadElementAttributeSliproad  
  • NMARoadElementAttributeHighway  
  • NMARoadElementAttributeUnderConstruction  
  • NMARoadElementAttributeHasLaneDir  
  • NMARoadElementAttributeHasLaneExit  
  • NMARoadElementAttributeFerry  
  • NMARoadElementAttributeRailFerry  

NMARoadElementPluralType

Include: NMAKit.framework/headers/NMARoadElement.h

Plural type identifies when a Junction is made up of multiple Road Elements. It also implies that a maneuver may require different explication than implied by the geometry.

Enumeration Members:

  • NMARoadElementPluralTypeNone

    Junction is not plural.

  • NMARoadElementPluralTypeManeuver

    Indicates that only one command should be given despite the fact that two Junctions occur – one at each end of the turn lane. It is only necessary to state "turn left/right" near the beginning of the maneuver because at the end the driver does not have a choice in direction.

  • NMARoadElementPluralTypeConnector

    Indicates that a road segment should not be viewed as an individual piece of road but as part of the intersection. A separate guidance manoeuvre should not exist for this segment.

  • NMARoadElementPluralTypeIndeterminate

    Indicates a maneuver that cannot be explained in one command or at all. A graphic may be needed to illustrate the turn. For example, a driver may need to go right to make a left turn.

NMARoadElementType

Include: NMAKit.framework/headers/NMARoadElement.h

Road element classifications.

The NAMRoadElementType describes the nature of the road that a NMARoadElement is part of. A road element may only have one type, or none if the road is an unclassified type or the information is not available.

Enumeration Members:

  • NMARoadElementTypeUndefined  
  • NMARoadElementTypeMotorway  
  • NMARoadElementTypeMultiCarriageway  
  • NMARoadElementTypeSingleCarriageway  
  • NMARoadElementTypeRoundabout  
  • NMARoadElementTypeSliproad  
  • NMARoadElementTypePedestrianZone  
  • NMARoadElementTypePedestrianWalkway  
  • NMARoadElementTypeServiceAccessParking  
  • NMARoadElementTypeServiceAccessOther  
  • NMARoadElementTypeServiceRoad  

Public Variable Details

const double NMAGeoPositionUnknownValue

Include: NMAKit.framework/headers/NMAGeoPosition.h

A constant used to indicate an unknown measurement value.

FOUNDATION_EXPORT const NSUInteger NMAMapObjectMaximumZIndex

Include: NMAKit.framework/headers/NMATypes.h

The maximum Z Index for an NMAMapObject

FOUNDATION_EXPORT const NSUInteger NMAMapObjectMinimumZIndex

Include: NMAKit.framework/headers/NMATypes.h

The minimum Z Index for an NMAMapObject

FOUNDATION_EXPORT const float NMAMapViewMaximumZoomLevel

Include: NMAKit.framework/headers/NMATypes.h

Upper limit of the NMAMapView zoomLevel property.

FOUNDATION_EXPORT const float NMAMapViewMinimumZoomLevel

Include: NMAKit.framework/headers/NMATypes.h

Lower limit of the NMAMapView zoomLevel property.

FOUNDATION_EXPORT NSString *const _Nonnull NMAPositioningManagerDidLosePositionNotification

Include: NMAKit.framework/headers/NMAPositioningManager.h

Indicates that the NMAPositioningManager currentPosition has been lost.

In order to receive this notification, register with NSNotificationCenter using this notification name and the [ NMAPositioningManager sharedPositioningManager] instance as the object (notification sender).

FOUNDATION_EXPORT NSString *const _Nonnull NMAPositioningManagerDidUpdatePositionNotification

Include: NMAKit.framework/headers/NMAPositioningManager.h

Indicates that the NMAPositioningManager currentPosition has changed.

NMAPositioningManager Notifications In order to receive this notification, register with NSNotificationCenter using this notification name and the [ NMAPositioningManager sharedPositioningManager] instance as the object (notification sender).

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.