HERE iOS SDK Developer's Guide

NMADiscoveryPage

Class Summary

class NMADiscoveryPage

Derived from: NSObject

Represents the paginated result of a NMADiscoveryRequest request.

Include: NMAKit.framework/headers/NMADiscoveryPage.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMADiscoveryPage

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSInteger  available

The total number of available NMAPlaceLink or NMADiscoveryLink objects for this discovery page

[readable, assign] NSArray< NMALink * > *  discoveryResults

Array of NMAPlaceLink or NMADiscoveryLink objects for the current page of results

[readable, assign] NMADiscoveryRequest nextPageRequest

The NMADiscoveryRequest for requesting the next page of results

[readable, assign] NSInteger  offsetCount

Result offset of the current results page into the total number of results avilable

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents the paginated result of a NMADiscoveryRequest request.

NMADiscoveryRequest objects are typically created using the NMAPlaces interface to initialize search, explore or here requests.

Results may be split into multiple page. Each results page contains a collection of NMAPlaceLink and NMADiscoveryLink objects, each of which represents either an actual place or a further discovery request.

Public Property Details

[readable, assign] NSInteger available

The total number of available NMAPlaceLink or NMADiscoveryLink objects for this discovery page.

[readable, assign] NSArray< NMALink * > * discoveryResults

Array of NMAPlaceLink or NMADiscoveryLink objects for the current page of results.

Note:

The discoveryResults may contain more results than the maximum number specified in NMARequest::collectionSize. These extra results link to different resources and contain further links via which the user will be linked to a place.

[readable, assign] NMADiscoveryRequestnextPageRequest

The NMADiscoveryRequest for requesting the next page of results.

Note:

This will be nil if there is no next page.

[readable, assign] NSInteger offsetCount

Result offset of the current results page into the total number of results avilable.

Note:

The number of results on the current page is the number of elements in discoveryResults.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly