HERE iOS SDK Developer's Guide

NMA Urban Mobility

Group Summary

group NMA Urban Mobility

The Urban Mobility group provides classes, callbacks, and enumerations that can be used to enable Urban Mobility functionality such as searching for nearby transit stations and requesting departure boards.

[For complete information, see the section Group Details]

Nested Classes

Public Typedef Summary

Table 2. Public Typedefs
Public Typedefs

(void) (^NMAUrbanMobilityCityCoverageRequestCompletionBlock) (NMAUrbanMobilityCityCoverageResult *_Nullable coverageResult, NSError *_Nullable error)

Defines a callback that is triggered upon the completion of a city coverage request. The resulting completion block contains a NMAUrbanMobilityCityCoverageResult or NSError.

(void) (^NMAUrbanMobilityCitySearchCompletionBlock) (NMAUrbanMobilityCitySearchResult *_Nullable searchResult, NSError *_Nullable error)

A completion block used to handle the search result of an Urban Mobility city search request.

(void) (^NMAUrbanMobilityDepartureBoardCompletionBlock) (NSArray< NMAUrbanMobilityDeparture * > *_Nullable departures, NSError *_Nullable error)

Defines a callback that is triggered upon the completion of a departure board request. The resulting completion block contains a list of NMAUrbanMobilityDeparture or NSError.

(void) (^NMAUrbanMobilityMultiBoardCompletionBlock) (NSArray< NMAUrbanMobilityStationWithDepartureBoard * > *_Nullable stations, NSArray< NMAUrbanMobilityTransport * > *_Nullable transports, NSError *_Nullable error)

Defines a callback which is triggered on the completion of a Multi Departure Board request. The resulting callback contains an array of NMAUrbanMobilityStationWithDepartureBoard, an array of NMAUrbanMobilityTransport or NSError.

(void) (^NMAUrbanMobilityNearbyCoverageRequestCompletionBlock) (NMAUrbanMobilityNearbyCoverageResult *_Nullable nearbyCoverageResult, NSError *_Nullable error)

Defines a callback that is triggered upon the completion of a departure board request. The resulting completion block contains a list of NMAUrbanMobilityDeparture or NSError.

(void) (^NMAUrbanMobilityStationSearchCompletionBlock) (NSArray< NMAUrbanMobilityStation * > *_Nullable stations, NSError *_Nullable error)

Defines a callback which is triggered on the completion of a station search request. The resulting callback contains an array of NMAUrbanMobilityStation or NSError.

Public Enumeration Summary

Table 3. Public Enumerations
Public Enumerations

NMACoverageUpdateType

NMAUrbanMobilityCoverageType

NMAUrbanMobilityError

This enum defines Urban Mobility operation errors.

NMAUrbanMobilityFareType

Type of NMAUrbanMobilityFare.

NMAUrbanMobilityFeatureAvailability

This enum defines availability options of a transit feature.

NMAUrbanMobilityLinkType

Type of the link as enum for convinient use. The allowed values are:

NMAUrbanMobilityManeuverDirection

Defines types of direction for a NMAUrbanMobilityManeuver.

NMAUrbanMobilityOperatorType

This enum defines the types of transit operators.

NMAUrbanMobilityOption

NMAUrbanMobilityRealTimeInfoStatus

NMAUrbanMobilityRoutingTypeOption

NMAUrbanMobilitySearchNameMatchingMethod

Name matching mode which is used when searching for transit stations.

NMAUrbanMobilitySearchOption

This enum defines the possible values that can be set by the optional flags in an Urban Mobility requests.

NMAUrbanMobilityTransportType

This enum defines Urban Mobility transport type (means of transport).

Public Variable Summary

Table 4. Public Variables
Public Variables

FOUNDATION_EXPORT const NSUInteger  NMARoutingModeDefaultMaximumChanges

FOUNDATION_EXPORT NSUInteger const  NMAUrbanMobilityValueNotAvailable

This constant value is set for Urban Mobility property that is not available from backend server.

Group Details

The Urban Mobility group provides classes, callbacks, and enumerations that can be used to enable Urban Mobility functionality such as searching for nearby transit stations and requesting departure boards.

IMPORTANT: Urban Mobility routing is a Beta feature. The related classes are subject to change without notice.

The Urban Mobility group provides classes, callbacks, and enumerations that can be used to enable Urban Mobility functionality such as searching for nearby transit stations and requesting departure boards.

IMPORTANT: Urban Mobility is a Beta feature. The related classes are subject to change without notice.

Key classes in this group are: NMAUrbanMobilityRequestManager, NMAUrbanMobilityStationSearchRequest, NMAUrbanMobilityDepartureBoardRequest, NMAUrbanMobilityMultiBoardRequest, NMAUrbanMobilityCitySearchRequest, NMAUrbanMobilityCityCoverageRequest, NMAUrbanMobilityNearbyCoverageRequest

Public Typedef Details

(void) (^NMAUrbanMobilityCityCoverageRequestCompletionBlock) (NMAUrbanMobilityCityCoverageResult *_Nullable coverageResult, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAUrbanMobilityCityCoverageRequest.h

Defines a callback that is triggered upon the completion of a city coverage request. The resulting completion block contains a NMAUrbanMobilityCityCoverageResult or NSError.

NMAUrbanMobilityCityCoverageRequestCompletionBlock is used with startWithCompletionBlock: to provide a callback for capturing responses from the HERE backend server.

Parameters:

  • coverageResult

    NMAUrbanMobilityCityCoverageResult returned by the HERE backend server.

  • error

    An error which occurred when requesting a city coverage board. Error codes are defined in NSError.

See also:

NMAUrbanMobilityCityCoverageResult

NSError

(void) (^NMAUrbanMobilityCitySearchCompletionBlock) (NMAUrbanMobilityCitySearchResult *_Nullable searchResult, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAUrbanMobilityCitySearchRequest.h

A completion block used to handle the search result of an Urban Mobility city search request.

Parameters:

  • searchResult

    NMAUrbanMobilityCitySearchResult. The result of the Urban Mobility city search request (can be nil if NSError error param is not nil).

  • error

    An NSError.

(void) (^NMAUrbanMobilityDepartureBoardCompletionBlock) (NSArray< NMAUrbanMobilityDeparture * > *_Nullable departures, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAUrbanMobilityDepartureBoardRequest.h

Defines a callback that is triggered upon the completion of a departure board request. The resulting completion block contains a list of NMAUrbanMobilityDeparture or NSError.

NMAUrbanMobilityDepartureBoardCompletionBlock is used with startWithCompletionBlock: to provide a callback for capturing responses from the HERE backend server.

Parameters:

  • departures

    List of NMAUrbanMobilityDeparture returned by the HERE backend server.

  • error

    An error which occurred when requesting a departure board. Error codes are defined in NSError.

See also:

NMAUrbanMobilityDeparture

NSError

(void) (^NMAUrbanMobilityMultiBoardCompletionBlock) (NSArray< NMAUrbanMobilityStationWithDepartureBoard * > *_Nullable stations, NSArray< NMAUrbanMobilityTransport * > *_Nullable transports, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAUrbanMobilityMultiBoardRequest.h

Defines a callback which is triggered on the completion of a Multi Departure Board request. The resulting callback contains an array of NMAUrbanMobilityStationWithDepartureBoard, an array of NMAUrbanMobilityTransport or NSError.

NMAUrbanMobilityMultiBoardCompletionBlock is used with NMAUrbanMobilityMultiBoardRequest::startWithCompletionBlock: to provide a callback for capturing responses from the HERE backend server.

Parameters:

  • stations

    Array of NMAUrbanMobilityStationWithDepartureBoard returned by the HERE backend server.

  • transports

    Array of NMAUrbanMobilityTransport returned by the HERE backend server.

  • error

    An error which occurred when searching for transit stations. Error codes are defined in NSError.

See also:

startWithCompletionBlock:

NMAUrbanMobilityStationWithDepartureBoard

NMAUrbanMobilityTransport

NSError

(void) (^NMAUrbanMobilityNearbyCoverageRequestCompletionBlock) (NMAUrbanMobilityNearbyCoverageResult *_Nullable nearbyCoverageResult, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAUrbanMobilityNearbyCoverageRequest.h

Defines a callback that is triggered upon the completion of a departure board request. The resulting completion block contains a list of NMAUrbanMobilityDeparture or NSError.

NMAUrbanMobilityNearbyCoverageRequestCompletionBlock is used with startWithCompletionBlock: to provide a callback for capturing responses from the HERE backend server.

Parameters:

  • nearbyCoverageResult

    NMAUrbanMobilityNearbyCoverageResult returned by the HERE backend server.

  • error

    An NSError which occurred when requesting a nearby coverage. Error codes are defined in NSError.

See also:

NMAUrbanMobilityNearbyCoverageResult

NSError

(void) (^NMAUrbanMobilityStationSearchCompletionBlock) (NSArray< NMAUrbanMobilityStation * > *_Nullable stations, NSError *_Nullable error)

Include: NMAKit.framework/headers/NMAUrbanMobilityStationSearchRequest.h

Defines a callback which is triggered on the completion of a station search request. The resulting callback contains an array of NMAUrbanMobilityStation or NSError.

NMAUrbanMobilityStationSearchCompletionBlock is used with startWithCompletionBlock: to provide a callback for capturing responses from the HERE backend server.

Parameters:

  • stations

    Array of NMAUrbanMobilityStation returned by the HERE backend server.

  • error

    An error which occurred when searching for transit stations. Error codes are defined in NSError.

See also:

startWithCompletionBlock:

NMAUrbanMobilityStation

NSError

Public Enumeration Details

NMACoverageUpdateType

Include: NMAKit.framework/headers/NMAUrbanMobilityCityCoverageRequest.h

See also:

updatetype parameter.

Enumeration Members:

  • NMACoverageUpdateTypeNew

    The resulting response contains only cities that are new (to HERE transit service) since the given date and time.

  • NMACoverageUpdateTypeUpdated

    The resulting response contains only cities with updated coverage information since the specified date and time.

  • NMACoverageUpdateTypeAll

    The resulting response contains cities that are either updated or new since a given date and time.

NMAUrbanMobilityCoverageType

Include: NMAKit.framework/headers/NMAUrbanMobilityNearbyCoverageResult.h

See also:

type parameter. It's a type of coverage in this area.

Enumeration Members:

  • NMAUrbanMobilityCoverageTypeRealTime

    real time type

  • NMAUrbanMobilityCoverageTypeSimpleRouting

    estimated routing type

  • NMAUrbanMobilityCoverageTypeTimeTable

    timetable type

  • NMAUrbanMobilityCoverageTypeUnknown

    any others(unknown) type

NMAUrbanMobilityError

Include: NMAKit.framework/headers/NMAUrbanMobility.h

This enum defines Urban Mobility operation errors.

Enumeration Members:

  • NMAUrbanMobilityErrorNone

    No error.

  • NMAUrbanMobilityErrorOffline

    Application is currently offline.

  • NMAUrbanMobilityErrorBadResponseCode

    Backend returned bad HTTP response.

  • NMAUrbanMobilityErrorMalformedResponse

    Backend returned malformed response.

  • NMAUrbanMobilityErrorUnknown

    Unknown error occurred.

  • NMAUrbanMobilityErrorUnauthorized

    Credentials which were sent to the backend server were not recognised as valid.

  • NMAUrbanMobilityErrorNoCoverage

    No coverage in this region/area.

  • NMAUrbanMobilityErrorNoResponse

    Backend did not return any response.

  • NMAUrbanMobilityErrorNotFound

    No search matches were found.

  • NMAUrbanMobilityErrorInvalidParameters

    Invalid request parameters were provided.

  • NMAUrbanMobilityErrorUnexpected

    Unexpected error occurred.

  • NMAUrbanMobilityErrorUnavailableAPI

    API is not available in this region/area.

  • NMAUrbanMobilityErrorInvalidPeriod

    Given period is invalid.

  • NMAUrbanMobilityErrorRoutingNotPossible

    Routing was not possible.

  • NMAUrbanMobilityErrorStartDestinationTooClose

    The start and destination locations are too close to each other.

  • NMAUrbanMobilityErrorNoStationNearby

    No stations were found near the given address.

  • NMAUrbanMobilityErrorInvalidOperation

    There was an error due to another request already being processed.

  • NMAUrbanMobilityErrorOutOfMemory

    There was insufficient memory to complete the request.

  • NMAUrbanMobilityErrorRoutingCancelled

    The request was cancelled.

  • NMAUrbanMobilityErrorViolatesOptions

    A route was found but is invalid because it makes use of roads that were disabled by NMARoutingOption.

  • NMAUrbanMobilityErrorInsufficientMapData

    The route cannot be calculated because there is not enough local map data to perform route calculation. Client can re-download map data and calculate route again.

  • NMAUrbanMobilityErrorServiceUnavailable

    The backend service was unavailable. Try again later.

  • NMAUrbanMobilityErrorNetworkCommunication

    There was a network communications error.

  • NMAUrbanMobilityErrorOperationNotAllowed

    Access to this operation is denied. Contact your HERE representative for more information.

NMAUrbanMobilityFareType

Include: NMAKit.framework/headers/NMAUrbanMobilityFare.h

Type of NMAUrbanMobilityFare.

Enumeration Members:

  • NMAUrbanMobilityFareTypeNotAvailable

    Price type not available.

  • NMAUrbanMobilityFareTypeHourly

    The indicated price is the cost per hour. Example: 11$/hour.

  • NMAUrbanMobilityFareTypeDaily

    The indicated price is the cost per day. Example: 62$/day.

  • NMAUrbanMobilityFareTypeRange

    The price represents a range with minimum and maximum value.

  • NMAUrbanMobilityFareTypeUnrecognized

    Unrecognized price type.

NMAUrbanMobilityFeatureAvailability

Include: NMAKit.framework/headers/NMAUrbanMobility.h

This enum defines availability options of a transit feature.

Enumeration Members:

  • NMAUrbanMobilityFeatureAvailabilityUnknown

    Feature availability is unknown.

  • NMAUrbanMobilityFeatureAvailable

    Feature is available.

  • NMAUrbanMobilityFeatureNotAvailable

    Feature is not available.

NMAUrbanMobilityLinkType

Include: NMAKit.framework/headers/NMAUrbanMobilityLink.h

Type of the link as enum for convinient use. The allowed values are:

Enumeration Members:

  • NMAUrbanMobilityLinkTypeAgency

    Link type agency: Operator information URL.

  • NMAUrbanMobilityLinkTypeTariff

    Link type tariff: Tariff information URL.

  • NMAUrbanMobilityLinkTypeWebsite

    Link type website: Website URL.

  • NMAUrbanMobilityLinkTypeBooking

    Link type booking: Booking URL.

  • NMAUrbanMobilityLinkTypeAlert

    Link type alert: Alert URL.

  • NMAUrbanMobilityLinkTypeUnknown

    Link type unknown.

NMAUrbanMobilityManeuverDirection

Include: NMAKit.framework/headers/NMAUrbanMobilityManeuver.h

Defines types of direction for a NMAUrbanMobilityManeuver.

Enumeration Members:

  • NMAUrbanMobilityManeuverDirectionUndefined

    An undefined direction.

  • NMAUrbanMobilityManeuverDirectionForward

    Direction forward.

  • NMAUrbanMobilityManeuverDirectionRight

    Direction right.

  • NMAUrbanMobilityManeuverDirectionLeft

    Direction left.

  • NMAUrbanMobilityManeuverDirectionBearRight

    Direction bear right.

  • NMAUrbanMobilityManeuverDirectionLightRight

    Direction light right.

  • NMAUrbanMobilityManeuverDirectionHardRight

    Direction hard right.

  • NMAUrbanMobilityManeuverDirectionUturnRight

    Direction uturn right.

  • NMAUrbanMobilityManeuverDirectionUturnLeft

    Direction uturn left.

  • NMAUrbanMobilityManeuverDirectionHardLeft

    Direction hard left.

  • NMAUrbanMobilityManeuverDirectionLightLeft

    Direction light left.

  • NMAUrbanMobilityManeuverDirectionBearLeft

    Direction bear left.

NMAUrbanMobilityOperatorType

Include: NMAKit.framework/headers/NMAUrbanMobilityOperator.h

This enum defines the types of transit operators.

Enumeration Members:

  • NMAUrbanMobilityOperatorTypeUnknown

    Unknown type.

  • NMAUrbanMobilityOperatorTypeEstimated

    Operator uses estimated times for departures and routing.

  • NMAUrbanMobilityOperatorTypeTimeTable

    Operator uses time tables for departures and routing.

  • NMAUrbanMobilityOperatorTypeRealTime

    Operator tracks real time changes to departures and routes.

NMAUrbanMobilityOption

Include: NMAKit.framework/headers/NMARoutingMode+UrbanMobility.h

Enumeration Members:

  • NMAUrbanMobilityOptionHighSpeedTrains

    Use high speed trains.

  • NMAUrbanMobilityOptionIntercityEurocityTrains

    Use euro city trains.

  • NMAUrbanMobilityOptionInterregionalFastTrains

    Use interregional fast trains.

  • NMAUrbanMobilityOptionRegionalTrains

    Use regional trains.

  • NMAUrbanMobilityOptionCityTrains

    Use city trains.

  • NMAUrbanMobilityOptionBusses

    Use busses.

  • NMAUrbanMobilityOptionBoatFerries

    Use boat or ferries.

  • NMAUrbanMobilityOptionMetroSubway

    Use metro or subway.

  • NMAUrbanMobilityOptionTram

    Use trams.

  • NMAUrbanMobilityOptionOrderedServiceTaxi

    Use ordered service as taxi.

  • NMAUrbanMobilityOptionInclinedFunicular

    Use inclined.

  • NMAUrbanMobilityOptionAerialCableCar

    Use aerial cable car.

  • NMAUrbanMobilityOptionRapidBus

    Use rapid bus.

  • NMAUrbanMobilityOptionMonorail

    Use monorail.

  • NMAUrbanMobilityOptionAirplane

    Use Airplane.

  • NMAUrbanMobilityOptionUndefined

    Undefined.

NMAUrbanMobilityRealTimeInfoStatus

Include: NMAKit.framework/headers/NMAUrbanMobilityRealTimeInfo.h

Enumeration Members:

  • NMAUrbanMobilityRealTimeInfoStatusOk

    Is scheduled at the original arrival/departure time and at the given platform.

  • NMAUrbanMobilityRealTimeInfoStatusRedirected

    The line is not following the normal stops sequence.

  • NMAUrbanMobilityRealTimeInfoStatusReplaced

    User should take a replacement transport for this departure/arrival.

  • NMAUrbanMobilityRealTimeInfoStatusCancelled

    The service has a permanent failure and will not arrive and depart.

  • NMAUrbanMobilityRealTimeInfoStatusAdditional

    This is an additional not planned service.

NMAUrbanMobilityRoutingTypeOption

Include: NMAKit.framework/headers/NMARoutingMode+UrbanMobility.h

Enumeration Members:

  • NMAUrbanMobilityRoutingTypeAll

    Return all form of routing. Timetable if available, and fall back to simple routing when not available.

  • NMAUrbanMobilityRoutingTypeTimeTable

    Return only time table type of results.

  • NMAUrbanMobilityRoutingTypeSimpleRouting

    Return only simple routing results.

  • NMAUrbanMobilityRoutingTypeRealTimeRouting

    Return only real time routing results.

NMAUrbanMobilitySearchNameMatchingMethod

Include: NMAKit.framework/headers/NMAUrbanMobilityStationSearchRequest.h

Name matching mode which is used when searching for transit stations.

Enumeration Members:

  • NMAUrbanMobilitySearchNameMatchingMethodUnspecified

    Search mode is not specified: up to the HERE backend server to decide.

  • NMAUrbanMobilitySearchNameMatchingMethodStrict

    Strict name match mode: names should be strictly equal.

  • NMAUrbanMobilitySearchNameMatchingMethodFuzzy

    Fuzzy name match mode: names are allowed to be slightly different.

NMAUrbanMobilitySearchOption

Include: NMAKit.framework/headers/NMAUrbanMobilitySearchRequest.h

This enum defines the possible values that can be set by the optional flags in an Urban Mobility requests.

Enumeration Members:

  • NMAUrbanMobilitySearchOptionUnset  
  • NMAUrbanMobilitySearchOptionYes  
  • NMAUrbanMobilitySearchOptionNo  

NMAUrbanMobilityTransportType

Include: NMAKit.framework/headers/NMAUrbanMobility.h

This enum defines Urban Mobility transport type (means of transport).

Enumeration Members:

  • NMAUrbanMobilityTransportTypeHighspeedTrain

    Highspeed train.

  • NMAUrbanMobilityTransportTypeIntercityTrain

    Intercity train.

  • NMAUrbanMobilityTransportTypeInterregionalTrain

    Interregional train.

  • NMAUrbanMobilityTransportTypeRegionalTrain

    Regional train.

  • NMAUrbanMobilityTransportTypeCityTrain

    City train.

  • NMAUrbanMobilityTransportTypeBus

    Bus.

  • NMAUrbanMobilityTransportTypeFerry

    Ferry.

  • NMAUrbanMobilityTransportTypeSubway

    Subway.

  • NMAUrbanMobilityTransportTypeTram

    Tram.

  • NMAUrbanMobilityTransportTypePrivateBus

    Ordered services/Private buses.

  • NMAUrbanMobilityTransportTypeInclined

    Inclined.

  • NMAUrbanMobilityTransportTypeAerial

    Aerial.

  • NMAUrbanMobilityTransportTypeRapidBus

    Rapid bus.

  • NMAUrbanMobilityTransportTypeMonorail

    Monorail.

  • NMAUrbanMobilityTransportTypeFlight

    Flight.

  • NMAUrbanMobilityTransportTypeUnknown

    Unknown.

  • NMAUrbanMobilityTransportTypeBike

    Use bike.

  • NMAUrbanMobilityTransportTypeBikeShare

    Use bike share.

  • NMAUrbanMobilityTransportTypeWalk

    Use walk.

  • NMAUrbanMobilityTransportTypeCar

    Use car.

  • NMAUrbanMobilityTransportTypeCarShare

    Use car share.

  • NMAUrbanMobilityTransportTypeTaxi

    Use taxi.

  • NMAUrbanMobilityTransportTypeUndefined

    Undefined transport type.

Public Variable Details

FOUNDATION_EXPORT const NSUInteger NMARoutingModeDefaultMaximumChanges

Include: NMAKit.framework/headers/NMARoutingMode+UrbanMobility.h

FOUNDATION_EXPORT NSUInteger const NMAUrbanMobilityValueNotAvailable

Include: NMAKit.framework/headers/NMAUrbanMobility.h

This constant value is set for Urban Mobility property that is not available from backend server.