MPLocation.h

Go to the documentation of this file.

//
//  Location.h
//  MapsIndoors SDK for iOS
//
//  Created by Daniel Nielsen on 7/29/13.
//  Copyright (c) 2017 MapsPeople A/S. All rights reserved.
//
 
#define kLocationPropertyDescription @"description"
#define kLocationPropertyDirections @"directions"
#define kLocationPropertyImage @"image"
#define kLocationPropertyOpeningHours @"openingHours"
#define kLocationPropertyContact @"contact"
#define kLocationPropertyPhone @"phone"
#define kLocationPropertyDate @"date"
#define kLocationPropertyEmail @"email"
#define kLocationPropertyFax @"fax"
#define kLocationPropertyTags @"_tags"
#define kLocationPropertyUrl @"www"
#define kLocationPropertyVideo @"video"
 
#import "MPJSONModel.h"
#import "MPLocationBaseType.h"
#import <UIKit/UIKit.h>
 
@class GMSCoordinateBounds;
@class GMSMarker;
@class MPLiveUpdate;
@class MPLocationField;
@class MPLocationProperty;
@class MPPoint;
@protocol MPLocationField;
 
@interface MPLocation : MPJSONModel
- (nullable instancetype) initWithPoint:(nullable MPPoint*)point andName:(nullable NSString*)name DEPRECATED_MSG_ATTRIBUTE("Use MPLocationUpdate instead");
- (nullable instancetype) initWithLocation:(nullable MPLocation*)location DEPRECATED_MSG_ATTRIBUTE("Use MPLocationUpdate instead");
 
@property (nonatomic, strong, nullable, readonly) NSString *locationId;
@property (nonatomic, strong, nullable, readonly) NSString *type;
@property (nonatomic, strong, nullable, readonly) NSNumber<Optional> *activeFrom DEPRECATED_ATTRIBUTE;
@property (nonatomic, strong, nullable, readonly) NSNumber<Optional> *activeTo DEPRECATED_ATTRIBUTE;
@property (nonatomic, strong, nullable, readonly) NSString<Optional> *venue;
@property (nonatomic, strong, nullable, readonly) NSString<Optional> *building;
@property (nonatomic, strong, nullable, readonly) NSString<Optional> *roomId DEPRECATED_MSG_ATTRIBUTE("Use externalId instead");
@property (nonatomic, strong, nullable, readonly) NSString<Optional> *externalId;
@property (nonatomic, strong, nullable, readonly) NSString<Optional> *descr;
@property (nonatomic, strong, nullable, readonly) NSDictionary<NSString*, MPLocationField*><Optional, MPLocationField> *fields;
- (nullable MPLocationField*) getFieldForKey:(nonnull NSString*)key NS_SWIFT_NAME(getField(forKey:));
@property (nonatomic, strong, nullable, readonly) NSArray<NSString*> *aliases;
@property (nonatomic, strong, nullable, readonly) NSString *name;
@property (nonatomic, strong, nullable, readonly) NSNumber* floor;
@property (nonatomic, strong, nullable, readonly) NSString* floorName;
@property (nonatomic, strong, nullable, readonly) NSMutableDictionary *categories;
@property (nonatomic, strong, nullable, readonly) NSMutableDictionary *properties DEPRECATED_MSG_ATTRIBUTE("Use fields dictionary instead");
//@property NSString *type;
@property (nonatomic, strong, nullable, readonly) MPPoint<Ignore> *geometry;
@property (nonatomic, strong, nullable, readonly) GMSMarker *marker DEPRECATED_MSG_ATTRIBUTE("Getting a marker from a location is not supported anymore, if you need to change the appearance of a location, create MPDisplaySettings for this");
@property (nonatomic, strong, nullable, readonly) UIImage *image DEPRECATED_MSG_ATTRIBUTE("Use -fields to get properties like image, description etc.");
 
@property (nonatomic, strong, nullable, readonly) NSString* imageURL;
@property (nonatomic, strong, nullable, readonly) NSNumber* sourceId;
 
@property (nonatomic, strong, nullable, readonly) UIImage*    icon;
 
@property (nonatomic, strong, nullable, readonly) NSURL*      iconUrl;
@property (nonatomic, readonly) MPLocationBaseType                      baseType;
 
@property (nonatomic, strong, nullable, readonly)  NSArray<NSString*>*       restrictions;
 
- (nullable MPPoint*)getPoint DEPRECATED_MSG_ATTRIBUTE("Use -getGeometry instead.");
 
- (nullable MPLocationProperty*)getProperty:(nullable NSString*)propertyType DEPRECATED_MSG_ATTRIBUTE("Use -getFields instead.");
- (nullable GMSCoordinateBounds*) getCoordinateBounds;
- (nullable NSObject*)getLiveValueForKey:(nonnull NSString*)key domainType:(nonnull NSString*)domainType;
- (nullable MPLiveUpdate*) getLiveUpdateForDomainType:(nonnull NSString*)domainType;
 
@property (nonatomic, readonly) BOOL        isIndoors;
 
@property (nonatomic, readonly) BOOL        isBookable;
 
@end