Configuration API reference

Version of the Configuration extension
The extensionVersion() API returns the version of the Configuration extension.
To get the version of the Configuration extension, use the following code sample:
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Flutter
Cordova
Unity
Xamarin
Android
Java
String coreExtensionVersion = MobileCore.extensionVersion();
iOS (AEP 3.x)
Swift
let version = MobileCore.extensionVersion
Objective C
NSString *version = [AEPMobileCore extensionVersion];
iOS (ACP 2.x)
Objective C
NSString *coreExtensionVersion = [ACPCore extensionVersion];
Swift
let coreExtensionVersion  = ACPCore.extensionVersion()
React Native
JavaScript
ACPCore.extensionVersion().then(coreExtensionVersion => console.log("AdobeExperienceSDK: ACPCore version: " + coreExtensionVersion));
Flutter
Dart
String coreExtensionVersion = await FlutterACPCore.extensionVersion;
Cordova
Cordova
ACPCore.extensionVersion(function(version) {  
   console.log("ACPCore version: " + version);
}, function(error) {  
   console.log(error);  
});
Unity
C#
string coreExtensionVersion = ACPCore.ExtensionVersion();
Xamarin
C#
string coreExtensionVersion = ACPCore.ExtensionVersion();
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 (AEP 3.x)
iOS (ACP 2.x)
Unity
Xamarin
Android
Syntax
public static void configureWithAppID(final String appId);
Example
Java
MobileCore.configureWithAppId("1423ae38-8385-8963-8693-28375403491d");
iOS (AEP 3.x)
Syntax
 static func configureWith(appId: String)
Example
Objective-C
 [AEPMobileCore configureWithAppId: @"1423ae38-8385-8963-8693-28375403491d"];
Swift
 MobileCore.configureWith(appId: "1423ae38-8385-8963-8693-28375403491d")
iOS (ACP 2.x)
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")
Unity
Syntax
public static void ConfigureWithAppID(string appId)
Example
C#
ACPCore.ConfigureWithAppID("1423ae38-8385-8963-8693-28375403491d");
Xamarin
Android Syntax
public unsafe static void ConfigureWithAppID (string appId);
iOS Syntax
public static void ConfigureWithAppID (string appid);
Example
C#
ACPCore.ConfigureWithAppID("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 key or any key with an environment prefix, because it can lead to unexpected behaviors. For more information, read Environment-aware configuration properties.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Flutter
Cordova
Unity
Xamarin
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 (AEP 3.x)
updateConfiguration
Syntax
 @objc(updateConfiguration:)
 static func updateConfigurationWith(configDict: [String: Any])
Example
Swift
 let updatedConfig = ["global.privacy":"optedout"]
 MobileCore.updateConfigurationWith(configDict: updatedConfig)
Objective-C
 NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
 [AEPMobileCore updateConfiguration:updatedConfig];
iOS (ACP 2.x)
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"});
Cordova
Javascript
Update SDK configuration
ACPCore.updateConfiguration({"newConfigKey":"newConfigValue"}, successCallback, errorCallback);
Unity
C#
Update SDK configuration
var dict = new Dictionary<string, object>();
dict.Add("newConfigKey", "newConfigValue");
ACPCore.UpdateConfiguration(dict);
Xamarin
C#
Update SDK configuration
iOS
 var config = new NSMutableDictionary<NSString, NSObject>
 {
   ["newConfigKey"] = new NSString("newConfigValue")
 };
ACPCore.UpdateConfiguration(config);
Android
var config = new Dictionary<string, Java.Lang.Object>();
config.Add("newConfigKey", "newConfigValue");
ACPCore.UpdateConfiguration(config);
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 (AEP 3.x)
iOS (ACP 2.x)
Xamarin
Android
Syntax
public static void configureWithFileInPath(final String filePath);
Example
Java
MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");
iOS (AEP 3.x)
Syntax
 static func configureWith(filePath: String)
Example
Objective-C
 NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"];
 [AEPMobileCore configureWithFilePath:filePath];
Swift
 let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
 MobileCore.configureWith(filePath: filePath)
iOS (ACP 2.x)
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)
Xamarin
Android Syntax
public unsafe static void ConfigureWithFileInPath (string filepath);
iOS Syntax
public static void ConfigureWithFileInPath (string filepath);
Example
C#
ACPCore.ConfigureWithFileInPath("absolute/path/to/exampleJSONfile.json");
configureWithFileInAssets (Android Only)
You can bundle a JSON configuration file in the app's Assets folder to replace or complement the configuration that was downloaded by using the Configure with Launch App ID approach.
Method configureWithFileInAssets was added in Android Core version 1.7.0.
Android
Android
Syntax
public static void configureWithFileInAssets(final String fileName);
Example
Java
MobileCore.configureWithFileInAssets("exampleJSONfile.json");
Configuration
Configuration event reference
Last updated 2 weeks ago