HERE iOS SDK Developer's Guide

NMAPlatformDataRequest

Class Summary

class NMAPlatformDataRequest

Derived from: NSObject

Runs the data requests with the specified parameters.

Include: NMAKit.framework/headers/NMAPlatformDataRequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAPlatformDataRequest

[For complete information, see the section Class Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Do not use

-(nullable instancetype) initWithLayers:(nonnull NSSet< NSString * > *) layers geoBoundingBox:(nonnull NMAGeoBoundingBox *) geoBoundingBox

Creates a data request with the specified layers and GeoBounding box

-(nullable instancetype) initWithLayers:(nonnull NSSet< NSString * > *) layers linkIds:(nonnull NSSet< NSNumber * > *) linkIds

Creates a data request with the specified layers and permanent link ids

-(nullable instancetype) initWithStaticLayer:(nonnull NSString *) layer

Creates a data request with the specified static layer

-(void) startWithBlock:(nonnull NMAPlatformDataRequestCompletionBlock ) block

Invokes the data request with the block

-(void) startWithListener:(nonnull id< NMAPlatformDataRequestListener >) requestListener

Invokes the data request with the specified listener

Class Method Summary

Table 2. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Runs the data requests with the specified parameters.

Instance Method Details

-(nonnull instancetype) init

Do not use.

-(nullable instancetype) initWithLayers:(nonnull NSSet< NSString * > *) layers geoBoundingBox:(nonnull NMAGeoBoundingBox *) geoBoundingBox

Creates a data request with the specified layers and GeoBounding box.

Parameters:

  • layers

    The layers to search for inside the specified GeoBoundingBox.

  • geoBoundingBox

    The GeoBoundingBox to be searched for the layers specifed.

Returns:

If the parameters are valid, an NMAPlatformDataRequest object configured with the parameters and nil otherwise.

-(nullable instancetype) initWithLayers:(nonnull NSSet< NSString * > *) layers linkIds:(nonnull NSSet< NSNumber * > *) linkIds

Creates a data request with the specified layers and permanent link ids.

Parameters:

  • layers

    The layers from which the data should be fetched, this request works only for road geometry layers.

  • linkIds

    The permanent link ids to be searched in the layers specifed.

Returns:

If the parameters are valid, an NMAPlatformDataRequest object configured with the parameters and nil otherwise.

-(nullable instancetype) initWithStaticLayer:(nonnull NSString *) layer

Creates a data request with the specified static layer. Note that a static layer doesn't require any bounding box or link ids to collect data.

Parameters:

  • layer

    The name of the static layer.

Returns:

If the parameter is valid, an NMAPlatformDataRequest object configured with the parameter and nil otherwise.

-(void) startWithBlock:(nonnull NMAPlatformDataRequestCompletionBlock ) block

Invokes the data request with the block.

Parameters:

  • block

    A block to run when the data received.

See also:

NMAPlatformDataRequestCompletionBlock

startWithListener:

-(void) startWithListener:(nonnull id< NMAPlatformDataRequestListener >) requestListener

Invokes the data request with the specified listener.

Parameters:

  • requestListener

    A listener to listen for the data results.

See also:

startWithBlock:

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly