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
[For complete information, see the section Class Details]
Public Property Summary
| Public Properties |
|---|
| [readable, assign] |
| [readable, assign] The string containing the attribution string for this NMAPlace |
| [readable, assign] The NSArray of NMACategory objects linking to categories that have been assigned to the NMAPlace |
| [readable, assign] Array of NMAContactDetail objects that provide information on how to contact the place |
| [readable, assign] NMAMediaCollectionPage of NMAMediaEditorial objects |
| [readable, assign] NSArray of NMAExtendedAttribute objects representing additional information about an NMAPlace |
| [readable, assign] An URL of icon that represents the NMAPlace |
| [readable, assign] NMAMediaCollectionPage of NMAMediaImage objects |
| [readable, assign] The NMAPlaceLocation of the NMAPlace |
| [readable, assign] |
| [readable, assign] NMAMediaCollectionPage of NMAMediaRating objects |
| [readable, assign] The NSDictionary of related places (where available) that might also interest an application user |
| [readable, assign] 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 of NMAMediaReview objects |
| [readable, assign] Link to the supplier of the NMAPlace. |
| [readable, assign] |
| [readable, assign] The user ratings for the NMAPlace |
| [readable, assign] URL to an external web page that represents the NMAPlace |
Instance Method Summary
| Instance Method Summary |
|---|
| 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.
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
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 Qype user Max Mustermann
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.
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.
Contact information for a place is optional. Attempts to read this property could return nil.
[readable, assign] NMAMediaCollectionPage * editorials
NMAMediaCollectionPage of NMAMediaEditorial objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.
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:
- payment - NMAExtendedAttribute
- openingHours - NMAExtendedAttribute
- annualClosings - NMAExtendedAttribute
- price - NMAExtendedAttribute
- nearestLandmark - NMAExtendedAttribute
- languagesSpoken - NMAExtendedAttribute
- availableParking - NMAExtendedAttribute
- smoking - NMAExtendedAttribute
- disabledAccess - NMAExtendedAttribute
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.
Application can download the icon online with this URL, but it needs to use its own icon for offline.
[readable, assign] NMAMediaCollectionPage * images
NMAMediaCollectionPage of NMAMediaImage objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.
Image content for a place is optional. Attempts to read this property could return nil.
[readable, assign] NMAPlaceLocation * location
The NMAPlaceLocation of the NMAPlace.
[readable, assign] NSString * name
The name of the NMAPlace and localized to language preference defined in NMARequest (if possible)
Attempts to read this property could return an empty string.
[readable, assign] NMAMediaCollectionPage * ratings
NMAMediaCollectionPage of NMAMediaRating objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.
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 ...).
Atempts to read this property could return nil.
[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.
A reporting link for a place is optional. Attempts to read this property could return nil.
[readable, assign] NMAMediaCollectionPage * reviews
NMAMediaCollectionPage of NMAMediaReview objects. See also NMAMediaCollectionPage::mediaContents related to this NMAPlace.
Review content for a place is optional. Attempts to read this property could return nil.
[readable, assign] NMALink * supplier
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://..."
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
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] NMARatings * userRatings
The user ratings for the NMAPlace.
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.
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.
A reference identifier will not be returned if it has not been queried with the NMARequest::addSource: method.
Parameters:
-
sourceNSString specifying the source
Returns:
An NSArray of reference identifiers. Return nil if reference identifier does not exist.