Configuration API reference

clearUpdatedConfiguration

You can clear any programmatic updates made to the configuration via the clearUpdatedConfiguration API. This will clear programmatic updates to configuration made via the updateConfiguration API. It will also clear any updates to the MobilePrivacyStatus(Android)/ PrivacyStatus(iOS) made via setPrivacyStatus.

Here are some scenarios based on the order of calls:

configureWithAppId
updateConfiguration
clearUpdatedConfiguration

Result: You end up with the initial configuration set via configureWithAppId.

Result: You end up with the initial configuration set via configureWithFileInPath.

configureWithAppId or configureWithFileInPath or configureWithFileInAssets
updateConfiguration
clearUpdatedConfiguration
updateConfiguration

Result: In this example, the configuration will be the most recently updated configuration and will not have any keys from the first update unless they are included in the most recent update.

configureWithAppId or configureWithFileInPath or configureWithFileInAssets
setPrivacyStatus
clearUpdatedConfiguration

Result: In this example, the configuration will have the initial MobilePrivacyStatus(Android)/ PrivacyStatus(iOS) set via configureWithAppId or configureWithFileInPath or configureWithFileInAssets.

Android

Java

Syntax

public static void clearUpdatedConfiguration();
Copied to your clipboard
public static void clearUpdatedConfiguration();

Example

MobileCore.clearUpdatedConfiguration();
Copied to your clipboard
MobileCore.clearUpdatedConfiguration();

iOS

Swift

Syntax

static func clearUpdatedConfiguration()
Copied to your clipboard
static func clearUpdatedConfiguration()

Example

MobileCore.clearUpdatedConfiguration()
Copied to your clipboard
MobileCore.clearUpdatedConfiguration()

Objective-C

Syntax

+ (void) clearUpdatedConfiguration(); 
Copied to your clipboard
+ (void) clearUpdatedConfiguration();

Example

[AEPMobileCore clearUpdatedConfiguration];
Copied to your clipboard
[AEPMobileCore clearUpdatedConfiguration];

Java

Syntax

public static void clearUpdatedConfiguration();
Copied to your clipboard
public static void clearUpdatedConfiguration();

Example

MobileCore.clearUpdatedConfiguration();
Copied to your clipboard
MobileCore.clearUpdatedConfiguration();

Swift

Syntax

static func clearUpdatedConfiguration()
Copied to your clipboard
static func clearUpdatedConfiguration()

Example

MobileCore.clearUpdatedConfiguration()
Copied to your clipboard
MobileCore.clearUpdatedConfiguration()

Objective-C

Syntax

+ (void) clearUpdatedConfiguration(); 
Copied to your clipboard
+ (void) clearUpdatedConfiguration();

Example

[AEPMobileCore clearUpdatedConfiguration];
Copied to your clipboard
[AEPMobileCore clearUpdatedConfiguration];

configureWithAppID

This API causes the SDK to download the configuration for the provided app ID and apply the configuration to the current session.

Android

Java

Syntax

public static void configureWithAppID(@NonNull final String appId);
Copied to your clipboard
public static void configureWithAppID(@NonNull final String appId);

Example

MobileCore.configureWithAppId("1423ae38-8385-8963-8693-28375403491d");
Copied to your clipboard
MobileCore.configureWithAppId("1423ae38-8385-8963-8693-28375403491d");

iOS

Swift

Syntax

 static func configureWith(appId: String)
Copied to your clipboard
 static func configureWith(appId: String)

Example

 MobileCore.configureWith(appId: "1423ae38-8385-8963-8693-28375403491d")
Copied to your clipboard
 MobileCore.configureWith(appId: "1423ae38-8385-8963-8693-28375403491d")

Objective-C

Syntax

+ (void) configureWithAppId: (NSString* appId);
Copied to your clipboard
+ (void) configureWithAppId: (NSString* appId);

Example

 [AEPMobileCore configureWithAppId: @"1423ae38-8385-8963-8693-28375403491d"];
Copied to your clipboard
 [AEPMobileCore configureWithAppId: @"1423ae38-8385-8963-8693-28375403491d"];

Java

Syntax

public static void configureWithAppID(@NonNull final String appId);
Copied to your clipboard
public static void configureWithAppID(@NonNull final String appId);

Example

MobileCore.configureWithAppId("1423ae38-8385-8963-8693-28375403491d");
Copied to your clipboard
MobileCore.configureWithAppId("1423ae38-8385-8963-8693-28375403491d");

Swift

Syntax

 static func configureWith(appId: String)
Copied to your clipboard
 static func configureWith(appId: String)

Example

 MobileCore.configureWith(appId: "1423ae38-8385-8963-8693-28375403491d")
Copied to your clipboard
 MobileCore.configureWith(appId: "1423ae38-8385-8963-8693-28375403491d")

Objective-C

Syntax

+ (void) configureWithAppId: (NSString* appId);
Copied to your clipboard
+ (void) configureWithAppId: (NSString* appId);

Example

 [AEPMobileCore configureWithAppId: @"1423ae38-8385-8963-8693-28375403491d"];
Copied to your clipboard
 [AEPMobileCore configureWithAppId: @"1423ae38-8385-8963-8693-28375403491d"];

configureWithFileInAssets

This API is only available in Android.

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 App ID per environment approach.

Android

Java

Syntax

public static void configureWithFileInAssets(@NonNull final String fileName);
Copied to your clipboard
public static void configureWithFileInAssets(@NonNull final String fileName);

Example

MobileCore.configureWithFileInAssets("exampleJSONfile.json");
Copied to your clipboard
MobileCore.configureWithFileInAssets("exampleJSONfile.json");

Java

Syntax

public static void configureWithFileInAssets(@NonNull final String fileName);
Copied to your clipboard
public static void configureWithFileInAssets(@NonNull final String fileName);

Example

MobileCore.configureWithFileInAssets("exampleJSONfile.json");
Copied to your clipboard
MobileCore.configureWithFileInAssets("exampleJSONfile.json");

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 App ID per environment approach.

To pass in a bundled path and file name:

Android

Java

Syntax

public static void configureWithFileInPath(@NonNull final String filePath);
Copied to your clipboard
public static void configureWithFileInPath(@NonNull final String filePath);

Example

MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");
Copied to your clipboard
MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");

iOS

Swift

Syntax

 static func configureWith(filePath: String)
Copied to your clipboard
 static func configureWith(filePath: String)

Example

 let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
 MobileCore.configureWith(filePath: filePath)
Copied to your clipboard
 let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
 MobileCore.configureWith(filePath: filePath)

Objective-C

Syntax

+ (void) configureWithFileInPath: (NSString* __nullable) filepath;
Copied to your clipboard
+ (void) configureWithFileInPath: (NSString* __nullable) filepath;

Example

 NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"];
 [AEPMobileCore configureWithFilePath:filePath];
Copied to your clipboard
 NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"];
 [AEPMobileCore configureWithFilePath:filePath];

Java

Syntax

public static void configureWithFileInPath(@NonNull final String filePath);
Copied to your clipboard
public static void configureWithFileInPath(@NonNull final String filePath);

Example

MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");
Copied to your clipboard
MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");

Swift

Syntax

 static func configureWith(filePath: String)
Copied to your clipboard
 static func configureWith(filePath: String)

Example

 let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
 MobileCore.configureWith(filePath: filePath)
Copied to your clipboard
 let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
 MobileCore.configureWith(filePath: filePath)

Objective-C

Syntax

+ (void) configureWithFileInPath: (NSString* __nullable) filepath;
Copied to your clipboard
+ (void) configureWithFileInPath: (NSString* __nullable) filepath;

Example

 NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"];
 [AEPMobileCore configureWithFilePath:filePath];
Copied to your clipboard
 NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"];
 [AEPMobileCore configureWithFilePath:filePath];

extensionVersion

The extensionVersion() API returns the version of the Configuration extension.

To get the version of the Configuration extension, use the following code sample:

Android

Java

String coreExtensionVersion = MobileCore.extensionVersion();
Copied to your clipboard
String coreExtensionVersion = MobileCore.extensionVersion();

iOS

Swift

let version = MobileCore.extensionVersion
Copied to your clipboard
let version = MobileCore.extensionVersion

Objective-C

NSString *version = [AEPMobileCore extensionVersion];
Copied to your clipboard
NSString *version = [AEPMobileCore extensionVersion];

Java

String coreExtensionVersion = MobileCore.extensionVersion();
Copied to your clipboard
String coreExtensionVersion = MobileCore.extensionVersion();

Swift

let version = MobileCore.extensionVersion
Copied to your clipboard
let version = MobileCore.extensionVersion

Objective-C

NSString *version = [AEPMobileCore extensionVersion];
Copied to your clipboard
NSString *version = [AEPMobileCore extensionVersion];

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

Java

Syntax

public static void updateConfiguration(@NonNull final Map configMap);
Copied to your clipboard
public static void updateConfiguration(@NonNull final Map configMap);

Example

HashMap<String, Object> data = new HashMap<String, Object>();
data.put("global.privacy", "optedout");
MobileCore.updateConfiguration(data);
Copied to your clipboard
HashMap<String, Object> data = new HashMap<String, Object>();
data.put("global.privacy", "optedout");
MobileCore.updateConfiguration(data);

iOS

Swift

Syntax

@objc(updateConfiguration:)
static func updateConfigurationWith(configDict: [String: Any])
Copied to your clipboard
@objc(updateConfiguration:)
static func updateConfigurationWith(configDict: [String: Any])

Example

 let updatedConfig = ["global.privacy":"optedout"]
 MobileCore.updateConfigurationWith(configDict: updatedConfig)
Copied to your clipboard
 let updatedConfig = ["global.privacy":"optedout"]
 MobileCore.updateConfigurationWith(configDict: updatedConfig)

Objective-C

Syntax

 + (void) updateConfiguration: (NSDictionary* __nullable) config;
Copied to your clipboard
 + (void) updateConfiguration: (NSDictionary* __nullable) config;

Example

 NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
 [AEPMobileCore updateConfiguration:updatedConfig];
Copied to your clipboard
 NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
 [AEPMobileCore updateConfiguration:updatedConfig];

Java

Syntax

public static void updateConfiguration(@NonNull final Map configMap);
Copied to your clipboard
public static void updateConfiguration(@NonNull final Map configMap);

Example

HashMap<String, Object> data = new HashMap<String, Object>();
data.put("global.privacy", "optedout");
MobileCore.updateConfiguration(data);
Copied to your clipboard
HashMap<String, Object> data = new HashMap<String, Object>();
data.put("global.privacy", "optedout");
MobileCore.updateConfiguration(data);

Swift

Syntax

@objc(updateConfiguration:)
static func updateConfigurationWith(configDict: [String: Any])
Copied to your clipboard
@objc(updateConfiguration:)
static func updateConfigurationWith(configDict: [String: Any])

Example

 let updatedConfig = ["global.privacy":"optedout"]
 MobileCore.updateConfigurationWith(configDict: updatedConfig)
Copied to your clipboard
 let updatedConfig = ["global.privacy":"optedout"]
 MobileCore.updateConfigurationWith(configDict: updatedConfig)

Objective-C

Syntax

 + (void) updateConfiguration: (NSDictionary* __nullable) config;
Copied to your clipboard
 + (void) updateConfiguration: (NSDictionary* __nullable) config;

Example

 NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
 [AEPMobileCore updateConfiguration:updatedConfig];
Copied to your clipboard
 NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
 [AEPMobileCore updateConfiguration:updatedConfig];

Overview

Last updated 6/4/2024

Was this helpful?

Yes

Configuration API reference

clearUpdatedConfiguration.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Java.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Swift

Objective-C

Java

Swift

Objective-C

configureWithAppID

Java

Swift

Objective-C

Java

Swift

Objective-C

configureWithFileInAssets

Java

Java

configureWithFileInPath

Java

Swift

Objective-C

Java

Swift

Objective-C

extensionVersion

Java

Swift

Objective-C

Java

Swift

Objective-C

updateConfiguration

Java

Swift

Objective-C

Java

Swift

Objective-C

clearUpdatedConfiguration

Java