HERE iOS SDK Developer's Guide

NMAPlaceLink

Class Summary

class NMAPlaceLink

Derived from: NMALink

Represents metadata about a place, this object is usually returned as a response to places search.

Include: NMAKit.framework/headers/NMAPlaceLink.h

Inheritance Diagrams

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] double  averageRating

The average rating for the NMAPlace if available, otherwise -1

[readable, assign] NMAGeoBoundingBox boundingBox

The enclosing NMAGeoBoundingBox describing a range of coordinates that correspond to the NMAPlace

[readable, assign] NMACategory category

The NMACategory to the primary category for the NMAPlace

[readable, assign] NSInteger  distance

The distance to the NMAPlace, in meters

[readable, assign] BOOL  isSponsored

Indicates whether this search result is sponsored

[readable, assign] NMAGeoCoordinates position

The NMAGeoCoordinates representing the geographical position of the NMAPlace

[readable, assign] NSString *  vicinityDescription

The NSString description of the vicinity surrounding the NMAPlaceLink

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull NMAPlaceRequest *) detailsRequest

Creates a request to retrieve the NMAPlace details

-(nonnull) init

-(nullable NSArray< NSString * & gt; *) referenceIdentifiersForSource:(nonnull NSString *) source

Get reference identifiers for a specific source. For example, a place can have a reference to an extruded building object in the map. The reference identifiers can be retrieved by calling this method with source NMAPlacesSourceBuilding.

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull) new

Class Details

Represents metadata about a place, this object is usually returned as a response to places search.

Note:

To retrieve the actual NMAPlace object use the detailsRequest property.

Public Property Details

[readable, assign] double averageRating

The average rating for the NMAPlace if available, otherwise -1.0 to indicate the value is not available.

[readable, assign] NMAGeoBoundingBoxboundingBox

The enclosing NMAGeoBoundingBox describing a range of coordinates that correspond to the NMAPlace. Typically, bounding boxes are associated with places such as cities and countries.

This bounding box does not necessarily have the location from the position property as its center. For example, if the search was performed with a street name, this bounding box may be one that contains the entire street, while position can be any point along the street.

Note:

Bounding box information for a place is optional. Attempts to read this property could return nil.

[readable, assign] NMACategorycategory

The NMACategory to the primary category for the NMAPlace.

[readable, assign] NSInteger distance

The distance to the NMAPlace, in meters.

Note:

Distance information for a place is optional. Attempts to read this property could return be zero.

[readable, assign] BOOL isSponsored

Indicates whether this search result is sponsored.

Applications should provide some visual differentiation between sponsored search results and regular search results.

Note:

Sponsorship is an optional attribute for a place.

[readable, assign] NMAGeoCoordinatesposition

The NMAGeoCoordinates representing the geographical position of the NMAPlace.

[readable, assign] NSString * vicinityDescription

The NSString description of the vicinity surrounding the NMAPlaceLink.

Typically, this property is derived from the address, but could also contain any other description that helps an application user understand where the place is located.

Instance Method Details

-(nonnull NMAPlaceRequest *) detailsRequest

Creates a request to retrieve the NMAPlace details. Each call to this method creates a new request object.

-(nonnull) init

Instances of this class should not be initialized directly

-(nullable NSArray< NSString * & gt; *) referenceIdentifiersForSource:(nonnull NSString *) source

Get reference identifiers for a specific source. For example, a place can have a reference to an extruded building object in the map. The reference identifiers can be retrieved by calling this method with source NMAPlacesSourceBuilding.

Index 0 is the primary reference identifier for the place.

Note:

A reference identifier will not be returned if it has not been queried with the NMARequest::addSource: function.

Parameters:

  • source

    NSString specifying the source

Returns:

An NSArray of reference identifiers. Return nil if reference identifier does not exist.

Class Method Details

+(nonnull) new

Instances of this class should not be initialized directly

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.