MCEConfig Class Reference

Inherits from NSObject
Declared in MCEConfig.h
MCEConfig.m

Overview

MCEConfig provides the current configuration of the SDK.

Other Methods

+ sharedInstanceWithDictionary:

This method allows you to configure the app with a NSDicionary instead of a MceConfig.json file

+ (instancetype)sharedInstanceWithDictionary:(NSDictionary *)dictionary

Discussion

This method allows you to configure the app with a NSDicionary instead of a MceConfig.json file

Declared In

MCEConfig.h

+ sharedInstance

This method returns the singleton object of this class.

+ (instancetype)sharedInstance

Discussion

This method returns the singleton object of this class.

Declared In

MCEConfig.h

Other Methods

  sessionTimeout

sessionTimeout specifies how long sessions last. It can be specified in the MceConfig.json file. If it is not specified, it is 20 minutes by default.

@property NSInteger sessionTimeout

Discussion

sessionTimeout specifies how long sessions last. It can be specified in the MceConfig.json file. If it is not specified, it is 20 minutes by default.

Declared In

MCEConfig.h

  baseUrl

baseUrl specifies where the SDK connects to. It can be specified in the MceConfig.json file. If it is not specified, it is https://api.ibm.com by default.

@property NSURL *baseUrl

Discussion

baseUrl specifies where the SDK connects to. It can be specified in the MceConfig.json file. If it is not specified, it is https://api.ibm.com by default.

Declared In

MCEConfig.h

  appKey

appKey specifies the appKey that is currently in use. A devAppKey and prodAppKey can be specified in the MceConfig.json file and are automatically determined on launch, depending on the environment the app is running in.

@property NSString *appKey

Discussion

appKey specifies the appKey that is currently in use. A devAppKey and prodAppKey can be specified in the MceConfig.json file and are automatically determined on launch, depending on the environment the app is running in.

Note: This value may not be correct on Apple Watch, please use MCERegistrationDetails.sharedInstance.appKey instead.

Declared In

MCEConfig.h

  autoInitializeFlag

autoInitializeFlag specifies if the SDK should initialize itself automatically or wait until the MCESdk manualInitialization method is called. This could be helpful if you want to limit the registered users and channels in your database. If not specified, this value is TRUE.

@property BOOL autoInitializeFlag

Discussion

autoInitializeFlag specifies if the SDK should initialize itself automatically or wait until the MCESdk manualInitialization method is called. This could be helpful if you want to limit the registered users and channels in your database. If not specified, this value is TRUE.

Declared In

MCEConfig.h

  autoInitializeLocationFlag

autoInitializeLocationFlag specifies if the SDK should initialize the location services at first launch or wait until the MCESdk manualLocationInitialization method is called.

@property BOOL autoInitializeLocationFlag

Discussion

autoInitializeLocationFlag specifies if the SDK should initialize the location services at first launch or wait until the MCESdk manualLocationInitialization method is called.

Declared In

MCEConfig.h

  appDelegateClass

appDelegateClass specifies the class that app delegate calls are forwarded to if you use the easy integration method. By default, it is not specified and does not forward calls that are not present in MceConfig.json.

@property Class _Nullable appDelegateClass

Discussion

appDelegateClass specifies the class that app delegate calls are forwarded to if you use the easy integration method. By default, it is not specified and does not forward calls that are not present in MceConfig.json.

Declared In

MCEConfig.h

  locationSyncRadius

locationSyncRadius specifies the size of the reference region to sync from the server to the device.

@property int locationSyncRadius

Discussion

locationSyncRadius specifies the size of the reference region to sync from the server to the device.

Declared In

MCEConfig.h

  locationSyncTimeout

locationSyncTimeout specifies the minimum frequently that the deivce can sync locations from the server.

@property int locationSyncTimeout

Discussion

locationSyncTimeout specifies the minimum frequently that the deivce can sync locations from the server.

Declared In

MCEConfig.h

  geofenceEnabled

geofenceEnabled specifies if geofences are enabled in the config file.

@property BOOL geofenceEnabled

Discussion

geofenceEnabled specifies if geofences are enabled in the config file.

Declared In

MCEConfig.h

  beaconEnabled

Are beacons enabled or not

@property BOOL beaconEnabled

Discussion

Are beacons enabled or not

Declared In

MCEConfig.h

  beaconUUID

Beacon UUID to search for

@property NSUUID *beaconUUID

Discussion

Beacon UUID to search for

Declared In

MCEConfig.h

  geofenceAccuracy

Location accuracy to set for location manager object

@property CLLocationAccuracy geofenceAccuracy

Discussion

Location accuracy to set for location manager object

Declared In

MCEConfig.h

  handoffUserActivityName

Name of user activity handoff activity name, used when the Apple Watch hands off actions to the iPhone paired with it. *

@property NSString *handoffUserActivityName

Discussion

Name of user activity handoff activity name, used when the Apple Watch hands off actions to the iPhone paired with it. *

Declared In

MCEConfig.h

  handoffInterfaceController

Name of the interface controller used to let the user know that they will need to continue the action on their iPhone. *

@property NSString *handoffInterfaceController

Discussion

Name of the interface controller used to let the user know that they will need to continue the action on their iPhone. *

Declared In

MCEConfig.h

  watchCategory

The name of the action cateory that is used to display dynamic watch notifications to the user. *

@property NSString *watchCategory

Discussion

The name of the action cateory that is used to display dynamic watch notifications to the user. *

Declared In

MCEConfig.h

  invalidateExistingUser

A configuration flag that resets the userId and channelId to new values on reinstallation. *

@property BOOL invalidateExistingUser

Discussion

A configuration flag that resets the userId and channelId to new values on reinstallation. *

Declared In

MCEConfig.h

  privateDatabaseStorage

A configuration flag writes databases to the iTunes file sharing location instead of private storage

@property BOOL privateDatabaseStorage

Discussion

A configuration flag writes databases to the iTunes file sharing location instead of private storage

Declared In

MCEConfig.h

  databaseEncryption

A configuration flag that determines if the databases are encrypted or not, the default value is true.

@property BOOL databaseEncryption

Discussion

A configuration flag that determines if the databases are encrypted or not, the default value is true.

Declared In

MCEConfig.h

  databaseKeyRotationDays

Database encryption key rotation frequency in day, the default value is 30 days.

@property int databaseKeyRotationDays

Discussion

Database encryption key rotation frequency in day, the default value is 30 days.

Declared In

MCEConfig.h

  autoReinitialize

This configuration flag allows the SDK to register with the server when the registration has been invalidated when it is set to true. When it is false, the application should check the MCERegistrationDetails.sharedInstance.userInvalidated response and when true execute MCESdk.sharedInstance’s manualInitialization method in order to register with the server again.

@property BOOL autoReinitialize

Discussion

This configuration flag allows the SDK to register with the server when the registration has been invalidated when it is set to true. When it is false, the application should check the MCERegistrationDetails.sharedInstance.userInvalidated response and when true execute MCESdk.sharedInstance’s manualInitialization method in order to register with the server again.

Declared In

MCEConfig.h

  allowJailbrokenDevices

This configuration flag allows jailbroken devices to continue to initialize the SDK. If it is set to false, jailbroken devices will not be allowed. The default value is true.

@property BOOL allowJailbrokenDevices

Discussion

This configuration flag allows jailbroken devices to continue to initialize the SDK. If it is set to false, jailbroken devices will not be allowed. The default value is true.

Declared In

MCEConfig.h