HERE iOS SDK Developer's Guide

NMAPlace

Class Summary

class NMAPlace

Derived from: NSObject

Represents a set of data about a physical place.

Include: NMAKit.framework/headers/NMAPlace.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAPlace

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSDictionary< NSString *, NSString * > *  alternativeNames

[readable, assign] NSString *  attributionText

The string containing the attribution string for this NMAPlace

[readable, assign] NSArray< NMACategory * > *  categories

The NSArray of NMACategory objects linking to categories that have been assigned to the NMAPlace

[readable, assign] NSArray< NMAContactDetail * > *  contacts

Array of NMAContactDetail objects that provide information on how to contact the place

[readable, assign] NMAMediaCollectionPage editorials

NMAMediaCollectionPage of NMAMediaEditorial objects

[readable, assign] NSArray< NMAExtendedAttribute * > *  extendedAttributes

NSArray of NMAExtendedAttribute objects representing additional information about an NMAPlace

[readable, assign] NSString *  iconUrl

An URL of icon that represents the NMAPlace

[readable, assign] NMAMediaCollectionPage images

NMAMediaCollectionPage of NMAMediaImage objects

[readable, assign] NMAPlaceLocation location

The NMAPlaceLocation of the NMAPlace

[readable, assign] NSString *  name

[readable, assign] NMAMediaCollectionPage ratings

NMAMediaCollectionPage of NMAMediaRating objects

[readable, assign] NSDictionary< NSString *, __kindof NMALink * > *  related

The NSDictionary of related places (where available) that might also interest an application user

[readable, assign] NMALink reportingLink

Gets the link for getting options for reporting a place because, for example, it contains inappropriate content or the place does not exist

[readable, assign] NMAMediaCollectionPage reviews

NMAMediaCollectionPage of NMAMediaReview objects

[readable, assign] NMALink supplier

Link to the supplier of the NMAPlace.

[readable, assign] NSString *  uniqueId

[readable, assign] NMARatings userRatings

The user ratings for the NMAPlace

[readable, assign] NSString *  viewUrl

URL to an external web page that represents the NMAPlace

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

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

Get reference identifiers for a specific source

Class Details

Represents a set of data about a physical place.

A NMAPlace acts as a container for various information about a place, which itself is a point of interest such as a popular restaurant, a park, or someone's home.

Note:

A NMAPlace can contain attributes, collections of media about the place, and key-value pairs of related places.

Public Property Details

[readable, assign] NSDictionary< NSString *, NSString * > * alternativeNames

Gets the NSDictionary for the alternative names of NMAPlace in a list of mapping languages and alternative names

Note:

An alternative name for a place is optional. Attempts to read this property could return nil.

[readable, assign] NSString * attributionText

The string containing the attribution string for this NMAPlace.

example : Provided by <a href=" http://originalArticle.. .">Qype user <a href=" http://userProfile.. .">Max Mustermann

Note:

Attribution text for a place is optional. Attempts to read this property could return nil.

[readable, assign] NSArray< NMACategory * > * categories

The NSArray of NMACategory objects linking to categories that have been assigned to the NMAPlace.

Note:

A NMACategory object extends the standard link object with an optional icon link pointing to an icon appropriate for that category. Categories for a place is optional. Attempts to read this property could return nil.

[readable, assign] NSArray< NMAContactDetail * > * contacts

Array of NMAContactDetail objects that provide information on how to contact the place.

Note:

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

[readable, assign] NMAMediaCollectionPageeditorials

NMAMediaCollectionPage of NMAMediaEditorial objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.

Note:

Editorial content for a place is optional. Attempts to read this property could return nil.

[readable, assign] NSArray< NMAExtendedAttribute * > * extendedAttributes

NSArray of NMAExtendedAttribute objects representing additional information about an NMAPlace.

An extensible collection of attributes can include:

Note:

Extended attribute for a place is optional. Attempts to read this property could return nil.

[readable, assign] NSString * iconUrl

An URL of icon that represents the NMAPlace.

Note:

Application can download the icon online with this URL, but it needs to use its own icon for offline.

[readable, assign] NMAMediaCollectionPageimages

NMAMediaCollectionPage of NMAMediaImage objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.

Note:

Image content for a place is optional. Attempts to read this property could return nil.

[readable, assign] NMAPlaceLocationlocation

The NMAPlaceLocation of the NMAPlace.

[readable, assign] NSString * name

The name of the NMAPlace and localized to language preference defined in NMARequest (if possible)

Note:

Attempts to read this property could return an empty string.

[readable, assign] NMAMediaCollectionPageratings

NMAMediaCollectionPage of NMAMediaRating objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.

Note:

Rating content for a place is optional. Attempts to read this property could return nil.

The NSDictionary of related places (where available) that might also interest an application user.

The NSDictionary is keyed by a localized title to language preference defined in NMARequest (if possible) of the related places (for example, "Nearby", "public-transport"), while the associated value is a link presented in class derived from NMALink(i.e.NMADiscoveryLink, NMAPlaceLink,etc ...).

Note:

Atempts to read this property could return nil.

Gets the link for getting options for reporting a place because, for example, it contains inappropriate content or the place does not exist.

Note:

A reporting link for a place is optional. Attempts to read this property could return nil.

[readable, assign] NMAMediaCollectionPagereviews

NMAMediaCollectionPage of NMAMediaReview objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.

Note:

Review content for a place is optional. Attempts to read this property could return nil.

[readable, assign] NMALinksupplier

Link to the supplier of the NMAPlace.

The supplier link extends the standard link object with an optional icon link that points to the supplier's brand icon.

Example:

"name": "Qype",
"url": "http://...",
"icon": "http://..."
Note:

A supplier link for a place is optional. Attempts to read this property could return nil.

[readable, assign] NSString * uniqueId

Unique consistent identifier for the place represented by this NMAPlace instance

Note:

The identifier value is consistent across application sessions. Applications that want to keep a reference to a specific place can store this identifier for subsequent linking to additional resources.

[readable, assign] NMARatingsuserRatings

The user ratings for the NMAPlace.

Note:

User ratings for a place are optional. Attempts to read this property could return nil.

[readable, assign] NSString * viewUrl

URL to an external web page that represents the NMAPlace.

Note:

Applications are encouraged to provide web links to places they display information about. Atempts to read this property could return an empty string.

Instance Method Details

-(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: method.

Parameters:

  • source

    NSString specifying the source

Returns:

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

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.