MRConfig Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in MRConfig.h

Overview

Holds Meridian configuration data for your application.

– editorURL

A convenience method to retrieve the current editor URL from the domainConfig

- (NSString *)editorURL

Return Value

The editor URL (ex: “https://edit-eu.meridianapps.com”)

Declared In

MRConfig.h

  domainConfig

Class to encapsulate domainName configuration data

@property (nonatomic, readonly) MRDomainConfig *domainConfig

Declared In

MRConfig.h

  spotlightConfiguration

Spotlight configuration for sharing location data such as placemarks with CoreSpotlight. If nil (the default) no indexing with CoreSpotlight will be performed

@property (nonatomic, nullable, strong) MRDSpotlightConfiguration *spotlightConfiguration

Declared In

MRConfig.h

  sdkHandlesLocationPermissionRequest

“If YES (default) the Meridian SDK will automatically handle iOS location permission requests”

@property (nonatomic, assign) BOOL sdkHandlesLocationPermissionRequest

Declared In

MRConfig.h

  disableCoreSpotlightIndexing

Disable CoreSpotlight integration for Placemarks. NO by default

@property (nonatomic, assign) BOOL disableCoreSpotlightIndexing

Declared In

MRConfig.h

  disableHapticFeedback

Disable Haptics feedback for map. NO by default

@property (nonatomic, assign) BOOL disableHapticFeedback

Declared In

MRConfig.h

  cacheOverridePolicy

NSURLSession cacheRequestPolicy to be used when communicating with the meridian server (default: NSURLRequestUseProtocolCachePolicy) If set to NSURLRequestReloadIgnoringLocalCacheData the NSURLSession URLCache will also be set to nil.

@property (nonatomic, assign) NSURLRequestCachePolicy cacheOverridePolicy

Declared In

MRConfig.h

  useSimulatedLocation

Flag to enable using simulated location on devices. Defaults to NO.

@property (nonatomic, assign) BOOL useSimulatedLocation

Declared In

MRConfig.h

  outdoorLocationAccuracyThreshold

When using system-provided services for outdoor location, readings will only be considered valid with an accuracy of at least this value in meters. Defaults to 10.

@property (nonatomic, assign) CGFloat outdoorLocationAccuracyThreshold

Declared In

MRConfig.h

  orientationWarningThreshold

Threshold (in degrees) used to determine whether the compass is aligned with the route Valid range is 45 - 90 degrees. Default value is 90.

@property (nonatomic, assign) NSInteger orientationWarningThreshold

Declared In

MRConfig.h

  orientationWarningDelay

When the compass is poorly aligned to the routing line, a warning is displayed after a period of time (in seconds) Valid range is 2.0 to 10.0 seconds. Default value is 5.0 seconds

@property (nonatomic, assign) NSTimeInterval orientationWarningDelay

Declared In

MRConfig.h

  rerouteDistance

Distance in meters a user’s location must diverge from the route before the route can be recalculated. Valid range is 5 - 30 meters. Default value is 10.

@property (nonatomic, assign) CGFloat rerouteDistance

Declared In

MRConfig.h

  rerouteDelay

Time in seconds that a user’s location must remain in divergence from the route before the route can be recalculated. Valid range is 5 - 15 seconds. Default value is 10.

@property (nonatomic, assign) NSTimeInterval rerouteDelay

Declared In

MRConfig.h

  includeUnpublishedMaps

If true, SDK APIs will also include maps that have not been marked published by the Editor.

@property (nonatomic, assign) BOOL includeUnpublishedMaps

Declared In

MRConfig.h

  logLevel

Logging level. Defaults to MRLogLevelWarn

@property (nonatomic, assign) MRLogLevel logLevel

Declared In

MRConfig.h

  applicationToken

Application Token. Can be generated at either edit.meridianapps.com > your location > Permissions > Application Token. edit-eu.meridianapps.com > your location > Permissions > Application Token.

@property (nonatomic, copy) NSString *applicationToken

Declared In

MRConfig.h

  largeListFloorPickerThreshold

When the floor picker is displaying greather than or equal to this number of total floors, the picker will first have the user choose a building. This limits the displayed results to the selected building. This is intended for locations with many buildings and floors. Defaults to 20.

@property (nonatomic, assign) NSInteger largeListFloorPickerThreshold

Declared In

MRConfig.h

  theme

Adjust the colors of various SDK elements

@property (nonatomic, strong) MRDTheme *theme

Declared In

MRConfig.h

+ configurationFromPlist:

Create an MRConfig from a given plist dictionary

+ (nullable instancetype)configurationFromPlist:(nonnull NSDictionary *)plist

Parameters

plist

NSDictionary representation of the plist to use for configuration

Return Value

MRConfig if one could be made, nil if not

Discussion

Note: all the properties of the plist will be read as Meridian[PropertyName] with the property name being capitalized. For example MeridianApplicationToken or MeridianRerouteDelay With a notable exception for MRDomainConfig which should be set with MeridianDomainRegion and a value of either MeridianDomainUS or MeridianDomainEU. Additionally MeridianEditorURL can be set to something like https://edit.meridianapps.com and a domain config will be created from that as well. Be sure to include the scheme when specifying MeridianEditorURL

Declared In

MRConfig.h