HERE iOS SDK Developer's Guide

NMAVenue3dService

Class Summary

class NMAVenue3dService

Derived from: NSObject

NMAVenue3dService offers methods to search for venues and to get NMAVenue3dVenue objects based on search.

Include: NMAKit.framework/headers/NMAVenue3dService.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dService

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] BOOL  combinedContent

A value indicating whether the HERE SDK and the HERE private 3D venue content will be used together

[readable, writable, assign] BOOL  devEnv

Defines whether a development or another backend is used

[readable, assign] NMAVenue3dServiceInitializationStatus   initializationStatus

The venue service initialization status

[readable, writable, assign] BOOL  privateContent

A value indicating whether the HERE SDK or the HERE private 3D venue content is to be used

[readable, writable, assign] BOOL  testEnv

Defines whether a normal or a test backend is used

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) addListener:(id< NMAVenue3dServiceListener >) listener

Add a listener to the venue service

-(void) getVenueWithInfo:( NMAVenue3dVenueInfo *) venueInfo

Asynchronously gets the NMAVenue3dVenue object that is specified by the given NMAVenue3dVenueInfo object

-(void) getVenuesWithInfoArray:(NSArray *) venueInfoArray

Asynchronously gets the NMAVenue3dVenue objects that are specified by the given list of NMAVenue3dVenueInfo objects

-(instancetype) initAdditionalVenueService

Returns a new additional NMAVenue3dService instance.

-(void) removeListener:(id< NMAVenue3dServiceListener >) listener

Remove a listener from the venue service

-(void) setHereAccountToken:(NSString *) token

Sets a HERE account token

-(void) start

Starts NMAVenue3dService asynchronously

-(void) stopWithCallback:(id< NMAVenue3dServiceStopListener >) stopListener

Stops NMAVenue3dService asynchronously

-( NMAVenue3dVenueInfo *) venueAtGeoCoordinates:( NMAGeoCoordinates *) coordinates

Searches for a venue closest to the given NMAGeoCoordinates

-( NMAVenue3dVenueInfo *) venueAtGeoCoordinates:( NMAGeoCoordinates *) coordinates radius:(float) radius

Searches for a venue closest to the given NMAGeoCoordinates within a radius

-( NMAVenue3dVenueInfo *) venueWithId:(NSString *) venueId

Gets venue info object for the venue identifier

-(NSArray *) venuesAtGeoCoordinates:( NMAGeoCoordinates *) coordinates

Searches for venues at the given NMAGeoCoordinates

-(NSArray *) venuesAtGeoCoordinates:( NMAGeoCoordinates *) coordinates radius:(float) radius

Searches for venues near the given NMAGeoCoordinates

-(NSArray *) venuesInGeoBoundingBox:( NMAGeoBoundingBox *) boundingBox

Searches for venues inside the given NMAGeoBoundingBox

Class Method Summary

Table 3. Class Methods
Class Methods

+(instancetype) sharedVenueService

Returns the singleton NMAVenue3dService instance.

+(void) stopAndClearCacheWithCallback:(id< NMAVenue3dServiceClearCacheListener >) listener

Clears cached data including all downloaded venues

Class Details

NMAVenue3dService offers methods to search for venues and to get NMAVenue3dVenue objects based on search.

Use of this object does not necessitate NMAMapView involvement.

This class can not be instantiated directly. Use NMAVenue3dService::sharedVenueService method to get the singeton instance of the class instead.

Public Property Details

[readable, writable, assign] BOOL combinedContent

A value indicating whether the HERE SDK and the HERE private 3D venue content will be used together. By default combined content is not used.

If NMAVenue3dService is using private content, then data from the private content will be used as primary source, and HERE SDK data as an alternative one. Otherwise the HERE SDK content will be primary source of data and the private content will be an alternative one. This property needs to be set before NMAVenue3DService::start. If NMAVenue3dService is already running, stop it first using NMAVenue3dService::stopAndClearCacheWithCallback: or NMAVenue3dService::stopWithCallback:, and then after calling this function, start it again using NMAVenue3dService::start.

[readable, writable, assign] BOOL devEnv

Defines whether a development or another backend is used. By default, the backend specified with the testEnv property is used.

This property needs to be set before NMAVenue3dService::start. If NMAVenue3dService is already running, stop it first using NMAVenue3dService::stopAndClearCacheWithCallback: or NMAVenue3dService::stopWithCallback:, and then after calling this function, start it again using NMAVenue3dService::start.

[readable, assign] NMAVenue3dServiceInitializationStatus  initializationStatus

The venue service initialization status.

[readable, writable, assign] BOOL privateContent

A value indicating whether the HERE SDK or the HERE private 3D venue content is to be used. The HERE SDK content is used by default.

This property needs to be set before NMAVenue3dService::start. If NMAVenue3dService is already running, stop it first using NMAVenue3dService::stopAndClearCacheWithCallback: or NMAVenue3dService::stopWithCallback:, and then after calling this function, start it again using NMAVenue3dService::start.

[readable, writable, assign] BOOL testEnv

Defines whether a normal or a test backend is used. The normal backend is used by default. This property is irrelevant when the property devEnv is true, because then the development backend is used.

This property needs to be set before NMAVenue3dService::start. If NMAVenue3dService is already running, stop it first using NMAVenue3dService::stopAndClearCacheWithCallback: or NMAVenue3dService::stopWithCallback:, and then after calling this function, start it again using NMAVenue3dService::start.

Instance Method Details

-(void) addListener:(id< NMAVenue3dServiceListener >) listener

Add a listener to the venue service. The listener must implement the NMAVenue3dServiceListener protocol. The listener monitors the venue service initialization status and a venue loaded completion event.

Parameters:

See also:

NMAVenue3dServiceListener

-(void) getVenueWithInfo:( NMAVenue3dVenueInfo *) venueInfo

Asynchronously gets the NMAVenue3dVenue object that is specified by the given NMAVenue3dVenueInfo object.

Venue service listeners will be notified when the venue is loaded via the [ NMAVenue3dServiceListener venueService:didGetVenue] method.

Parameters:

  • venueInfo

    The NMAVenue3dVenueInfo object specifying venue to be get.

See also:

NMAVenue3dVenueInfo:

-(void) getVenuesWithInfoArray:(NSArray *) venueInfoArray

Asynchronously gets the NMAVenue3dVenue objects that are specified by the given list of NMAVenue3dVenueInfo objects.

Venue service listeners will be notified when a venue is loaded via the [ NMAVenue3dServiceListener venueService:didGetVenue] method.

Parameters:

  • venueInfoArray

    An array of NMAVenue3dVenueInfo objects specifying venues to get.

See also:

NMAVenue3dVenueInfo:

-(instancetype) initAdditionalVenueService

Returns a new additional NMAVenue3dService instance.

Note:

Use this method to obtain a new additional NMAVenue3dService instance.

Note:

The returned object isn't related to the shared singleton NMAVenue3dService instance.

-(void) removeListener:(id< NMAVenue3dServiceListener >) listener

Remove a listener from the venue service. The listener must implement the NMAVenue3dServiceListener protocol. The listener monitors the venue service initialization status and a venue loaded completion event.

Parameters:

-(void) setHereAccountToken:(NSString *) token

Sets a HERE account token. In case of valid token and if private content is used, {VenueService} will be using private bucket of a HERE account instead of private bucket of the app.

Parameters:

  • token

    a HERE account token.

-(void) start

Starts NMAVenue3dService asynchronously. The method will do nothing if NMAVenue3dService is already initialized with status NMAVenue3dServiceInitializationStatusOnlineSuccess.

An initialization status is returned to objects registered as NMAVenue3dServiceListener to NMAVenue3dService.

-(void) stopWithCallback:(id< NMAVenue3dServiceStopListener >) stopListener

Stops NMAVenue3dService asynchronously. NMAVenue3dServiceStopListener::didStopVenueService: callback will be called and this callback also indicates that no more Venue loading is happening anymore. Use NMAVenue3dService::start to start the service again.

Parameters:

  • stopListener

    Notification callback.

-( NMAVenue3dVenueInfo *) venueAtGeoCoordinates:( NMAGeoCoordinates *) coordinates

Searches for a venue closest to the given NMAGeoCoordinates .

Parameters:

  • coordinates

    The location around which to search for venues.

Returns:

The closet NMAVenue3dVenueInfo object to the specified point or nil if there is no any.

See also:

NMAVenue3dVenueInfo

-( NMAVenue3dVenueInfo *) venueAtGeoCoordinates:( NMAGeoCoordinates *) coordinates radius:(float) radius

Searches for a venue closest to the given NMAGeoCoordinates within a radius.

Parameters:

  • coordinates

    The location around which to search for venues.

  • radius

    The radius in meters where to search venues.

Returns:

The closet NMAVenue3dVenueInfo object to the specified point or nil if there is no any

See also:

NMAVenue3dVenueInfo

-( NMAVenue3dVenueInfo *) venueWithId:(NSString *) venueId

Gets venue info object for the venue identifier.

Parameters:

  • venueId

    venue id

Returns:

Venue info object for the venue identifier

See also:

getVenueWithInfo:

-(NSArray *) venuesAtGeoCoordinates:( NMAGeoCoordinates *) coordinates

Searches for venues at the given NMAGeoCoordinates .

Parameters:

  • coordinates

    The location around which to search for venues.

Returns:

An array of NMAVenue3dVenueInfo objects representing the venues found near the specified location.

See also:

NMAVenue3dVenueInfo

-(NSArray *) venuesAtGeoCoordinates:( NMAGeoCoordinates *) coordinates radius:(float) radius

Searches for venues near the given NMAGeoCoordinates .

Parameters:

  • coordinates

    The location around which to search for venues.

  • radius

    The radius in meters where to search venues.

Returns:

The array of NMAVenue3dVenueInfo objects found near the specified point

See also:

NMAVenue3dVenueInfo

-(NSArray *) venuesInGeoBoundingBox:( NMAGeoBoundingBox *) boundingBox

Searches for venues inside the given NMAGeoBoundingBox .

Parameters:

  • boundingBox

    The area in which to search for venues.

Returns:

An array of NMAVenue3dVenueInfo objects representing the venues found inside the specified area.

See also:

NMAVenue3dVenueInfo

Class Method Details

+(instancetype) sharedVenueService

Returns the singleton NMAVenue3dService instance.

Note:

Use this method to obtain a shared singleton NMAVenue3dService instance.

+(void) stopAndClearCacheWithCallback:(id< NMAVenue3dServiceClearCacheListener >) listener

Clears cached data including all downloaded venues. All running instances of venue service will be stopped asynchronously and locked ( initializationStatus will return NMAVenue3dServiceInitializationStatusLocked during the operation). After the cache is cleared, NMAVenue3dService needs to be started again using the NMAVenue3dService::start method.

Parameters:

  • listener

    Notification callback.

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.