MPLocation Class Reference

#include <MPLocation.h>

Inheritance diagram for MPLocation:

Instance Methods
(nullable instancetype)	- initWithPoint:andName:
(nullable instancetype)	- initWithLocation:
(nullable MPLocationField *)	- getFieldForKey:
(nullable MPPoint *)	- getPoint
(nullable MPLocationProperty *)	- getProperty:
(nullable GMSCoordinateBounds *)	- getCoordinateBounds
(nullable NSObject *)	- getLiveValueForKey:domainType:
(nullable MPLiveUpdate *)	- getLiveUpdateForDomainType:

Properties
NSString *	locationId
NSString *	type
NSNumber< Optional > *	activeFrom
NSNumber< Optional > *	activeTo
NSString< Optional > *	venue
NSString< Optional > *	building
NSString< Optional > *	roomId
NSString< Optional > *	externalId
NSString< Optional > *	descr
NSDictionary< NSString *, MPLocationField * >< Optional, MPLocationField > *	fields
NSArray< NSString * > *	aliases
NSString *	name
NSNumber *	floor
NSString *	floorName
NSMutableDictionary *	categories
NSMutableDictionary *	properties
MPPoint< Ignore > *	geometry
GMSMarker *	marker
UIImage *	image
NSString *	imageURL
NSNumber *	sourceId
UIImage *	icon
NSURL *	iconUrl
MPLocationBaseType	baseType
NSArray< NSString * > *	restrictions
BOOL	isIndoors
BOOL	isBookable

Detailed Description

This class holds the data for a single location and a marker to display the data on a map.

Method Documentation

getCoordinateBounds

- (nullable GMSCoordinateBounds *) getCoordinateBounds

Get coordinate bounds for the location object

getFieldForKey:

- (nullable MPLocationField *) getFieldForKey:

(nonnull NSString *)

key

Get data for custom property with key, disregarding casing of key.

Parameters

key	identifier for custom property.

Returns

MPLocationField* or nil.

getLiveUpdateForDomainType:

- (nullable MPLiveUpdate *) getLiveUpdateForDomainType:

(nonnull NSString *)

domainType

Get a live update based on a known domain type

getLiveValueForKey:domainType:

- (nullable NSObject *) getLiveValueForKey:		(nonnull NSString *)	key
domainType:		(nonnull NSString *)	domainType

Get a live property value based on a known key and domain type

getPoint

- (nullable MPPoint *) getPoint

Get the point holding coordinates for the location object

getProperty:

- (nullable MPLocationProperty *) getProperty:

(nullable NSString *)

propertyType

Get location property of the given type identifier

initWithLocation:

- (nullable instancetype) initWithLocation:

(nullable MPLocation *)

location

Location constructor.

Parameters

location

Make a new instance from an existing location.

Deprecated

Use MPLocationUpdate instead

initWithPoint:andName:

- (nullable instancetype) initWithPoint:		(nullable MPPoint *)	point
andName:		(nullable NSString *)	name

Location constructor.

Parameters

point	The geographic point.
name	The name of the location.

Deprecated

Use MPLocationUpdate instead

Implemented in MPPositionIndicator.

Property Documentation

activeFrom

- (NSNumber<Optional>*) activeFrom

readnonatomicstrong

Active from timestamp

Deprecated

activeTo

- (NSNumber<Optional>*) activeTo

readnonatomicstrong

Active to timestamp

Deprecated

aliases

- (NSArray<NSString*>*) aliases

readnonatomicstrong

Get aliases for location.

baseType

- (MPLocationBaseType) baseType

readnonatomicassign

Location base type.

building

- (NSString<Optional>*) building

readnonatomicstrong

Location building property. This string correlates with MPBuilding.administrativeId.

categories

- (NSMutableDictionary*) categories

readnonatomicstrong

The categories for this location, as a dictionary.

descr

- (NSString<Optional>*) descr

readnonatomicstrong

Location description property.

externalId

- (NSString<Optional>*) externalId

readnonatomicstrong

Location external id property.

fields

- (NSDictionary<NSString*, MPLocationField*><Optional, MPLocationField> *) fields

readnonatomicstrong

Custom properties associated with the location object. Keys are case sensitive. For case-insensitive access to custom properties use

See also

-[- getFieldForKey:]

floor

- (NSNumber*) floor

readnonatomicstrong

If the location resides on a specific floor level, this property is set. This value correlates with MPFloor.zIndex.

floorName

- (NSString*) floorName

readnonatomicstrong

If the location resides on a specific floor level, the name of that floor level can be retrieved here.

geometry

- (MPPoint<Ignore>*) geometry

readnonatomicstrong

The data type (equals "Feature"). Geometry as a Lat/Long point.

icon

- (UIImage*) icon

readnonatomicstrong

Location icon. If nil, the location will either get an icon from the settings configured for the type of location or a default appearance that is configurable through MPMapControl.

iconUrl

- (NSURL*) iconUrl

readnonatomicstrong

Location icon as a URL. If icon is originally set as a UIImage, this property will be ignored.

image

- (UIImage*) image

readnonatomicstrong

Location image.

imageURL

- (NSString*) imageURL

readnonatomicstrong

URL for image associated with this MPLocation.

isBookable

- (BOOL) isBookable

readnonatomicassign

Determines if the MPLocation is bookable using the MPBookingService.

isIndoors

- (BOOL) isIndoors

readnonatomicassign

Will return YES if location is indoors and belongs to a building, otherwise NO.

locationId

- (NSString*) locationId

readnonatomicstrong

Location id property.

marker

- (GMSMarker*) marker

readnonatomicstrong

Marker property used to display on map.

name

- (NSString*) name

readnonatomicstrong

Location name.

properties

- (NSMutableDictionary*) properties

readnonatomicstrong

Dictionary of location properties. The keys 'image' and 'description' will always be present, and possibly others, such as 'address', 'contact', 'openinghours' and '_tags' or your own data structure.

Deprecated

Use fields dictionary instead

restrictions

- (NSArray<NSString*>*) restrictions

readnonatomicstrong

If set, location is restricted to given set of app user roles.

roomId

- (NSString<Optional>*) roomId

readnonatomicstrong

Location room id property.

Deprecated

Use externalId instead

sourceId

- (NSNumber*) sourceId

readnonatomicstrong

Location Source ID. Some implementations have different location sources, and this id is a reference to the location source that created the location. The source ID will remain the same throughout the running application session, but the source ID is not expected to remain the same across sessions.

type

- (NSString*) type

readnonatomicstrong

Location type property. This string correlates with MPType.name.

venue

- (NSString<Optional>*) venue

readnonatomicstrong

Location venue property. This string correlates with MPVenue.venueKey.