HERE iOS SDK Developer's Guide

NMARequest

Class Summary

class NMARequest

Derived from: NSObject

Represents a base interface for a search request.

Include: NMAKit.framework/headers/NMARequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMARequest

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NSUInteger  collectionSize

The maximum number of items in the response

[readable, writable, strong] NSString *  languagePreference

NSString representing the preferred language for request responses

[readable, assign] NSArray< NSString * > *  sources

The NSArray of sources have been added for a NMAPlace

[readable, writable, strong] NSString *  userTag

User-defined Tag as convenience method to identify NMARequest

[readable, writable, assign] NMAGeoBoundingBox viewport

The bounding box in which to perform the search

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) addSource:(add(source:)) NS_SWIFT_NAME

This function adds the a reference identifier to be returned in the request results

-(BOOL) cancel

Cancels any pending query request

-(nullable NSError *) startWithBlock:(start(block:)) NS_SWIFT_NAME

Invokes an asynchronous query request with a specified block

-(nullable NSError *) startWithListener:(start(listener:)) NS_SWIFT_NAME

Invokes an asynchronous query request with a specified listener

Class Details

Represents a base interface for a search request.

Public Property Details

[readable, writable, assign] NSUInteger collectionSize

The maximum number of items in the response.

Note:

The default value is 10. The maximum value is 100, if over, it's capped to 100.

[readable, writable, strong] NSString * languagePreference

NSString representing the preferred language for request responses.

Default Value: [[NSLocale preferredLanguages] objectAtIndex:0].

Note:

languagePreference should be a valid code according to the IETF BCP-47 standard (see http://tools.ietf.org/html/bcp47 ).

[readable, assign] NSArray< NSString * > * sources

The NSArray of sources have been added for a NMAPlace.

See also:

NMARequest::addSource:

[readable, writable, strong] NSString * userTag

User-defined Tag as convenience method to identify NMARequest.

Note:

The default value for userTag is empty string and user should assign any tag value with their own convention.

[readable, writable, assign] NMAGeoBoundingBoxviewport

The bounding box in which to perform the search.

The viewport can act as an implicit location context in the absence of an explicit location context. To ensure you get the best results possible, you should match the viewport to your map if there is a map visible to the user.

Instance Method Details

-(void) addSource:(add(source:)) NS_SWIFT_NAME

This function adds the a reference identifier to be returned in the request results. See also NMAPlace::referenceIdentifiersForSource:.

Examples of reference identifiers are: "NMAPlacesSourcePVID" for HERE's core content product which provides map and POI data, "NMAPlacesSourceVenuesAll" for HERE's venue maps product whcih provides indoor maps for thousands of venues, "NMAPlacesSourceBuilding" for extruded building.

Parameters:

  • source

    A string containing the source identifier to add.

-(BOOL) cancel

Cancels any pending query request.

-(nullable NSError *) startWithBlock:(start(block:)) NS_SWIFT_NAME

Invokes an asynchronous query request with a specified block.

Parameters:

  • aBlock

    A block to be executed upon completion of the request

Returns:

The appropriate NSError code

See also:

NMARequestCompletionBlock

startWithListener:

-(nullable NSError *) startWithListener:(start(listener:)) NS_SWIFT_NAME

Invokes an asynchronous query request with a specified listener.

Parameters:

  • aSearchEventListener

    A listener to listen for search results

Returns:

The appropriate NSError code

See also:

startWithBlock:

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.