Configuration API reference

configureWithAppID
This API causes the SDK to download the configuration for the provided app ID and apply the configuration to the current session.
Android
iOS
Android
This API causes the SDK to download the configuration for the provided app ID and apply the configuration to the current session.
Syntax
public static void configureWithAppID(final String appId);
Example
Java
MobileCore.ConfigureWithAppId("1423ae38-8385-8963-8693-28375403491d");
iOS
Syntax
+ (void) configureWithAppId: (NSString* __nullable) appid;
Example
Objective-C
[ACPCore configureWithAppId:@"1423ae38-8385-8963-8693-28375403491d"];
Swift
ACPCore.configure(withAppId: "1423ae38-8385-8963-8693-28375403491d")
updateConfiguration
You can also update the configuration programmatically by passing configuration keys and values to override the existing configuration.
Keys that are not found on the current configuration are added when this method is followed. Null values are allowed and replace existing configuration values.
Do not use this API to update the build.environment or any key with an environment prefix, because it can lead to unexpected behaviors. For more information, read Environment-aware configuration properties.
Android
iOS
React Native
Flutter
Android
updateConfiguration
Syntax
public static void updateConfiguration(final Map configMap);
Example
Java
HashMap<String, Object> data = new HashMap<String, Object>();
data.put("global.privacy", "optedout");
MobileCore.updateConfiguration(data);
iOS
updateConfiguration
Syntax
+ (void) updateConfiguration: (NSDictionary* __nullable) config;
Example
Objective-C
NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
[ACPCore updateConfiguration:updatedConfig];
Swift
let updatedConfig = ["global.privacy":"optedout"]
ACPCore.updateConfiguration(updatedConfig)
React Native
JavaScript
updateConfiguration
ACPCore.updateConfiguration({"global.privacy":"optedout"});
Flutter
Dart
updateConfiguration
FlutterACPCore.updateConfiguration({"global.privacy":"optedout"});
configureWithFileInPath
You can include a bundled JSON configuration file in your app package to replace or complement the configuration that was downloaded by using the Configure with Launch App ID approach.
To pass in a bundled path and file name:
Android
iOS
Android
Syntax
public static void configureWithFileInPath(final String filePath);
Example
Java
MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");
iOS
Syntax
+ (void) configureWithFileInPath: (NSString* __nullable) filepath;
Example
Objective-C
NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile"ofType:@"json"];
[ACPCore configureWithFileInPath:filePath];
Swift
let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
ACPCore.configureWithFile(inPath: filePath)
Configuration
Configuration event reference
Last updated 6 days ago