API Reference

extensionVersion

The extensionVersion() API returns the version of the client-side Consent extension.

Android

Java

Syntax

public static String extensionVersion();
Copied to your clipboard
public static String extensionVersion();

Example

String extensionVersion = Consent.extensionVersion();
Copied to your clipboard
String extensionVersion = Consent.extensionVersion();

Kotlin

Example

val extensionVersion = Consent.extensionVersion()
Copied to your clipboard
val extensionVersion = Consent.extensionVersion()

iOS

Swift

Syntax

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

Example

let extensionVersion = Consent.extensionVersion
Copied to your clipboard
let extensionVersion = Consent.extensionVersion

Objective-C

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

NSString *extensionVersion = [AEPMobileEdgeConsent extensionVersion];
Copied to your clipboard
NSString *extensionVersion = [AEPMobileEdgeConsent extensionVersion];

Java

Syntax

public static String extensionVersion();
Copied to your clipboard
public static String extensionVersion();

Example

String extensionVersion = Consent.extensionVersion();
Copied to your clipboard
String extensionVersion = Consent.extensionVersion();

Kotlin

Example

val extensionVersion = Consent.extensionVersion()
Copied to your clipboard
val extensionVersion = Consent.extensionVersion()

Swift

Syntax

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

Example

let extensionVersion = Consent.extensionVersion
Copied to your clipboard
let extensionVersion = Consent.extensionVersion

Objective-C

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

NSString *extensionVersion = [AEPMobileEdgeConsent extensionVersion];
Copied to your clipboard
NSString *extensionVersion = [AEPMobileEdgeConsent extensionVersion];

getConsents

Retrieves the current consent preferences stored in the Consent extension.

Android

Java

Syntax

public static void getConsents(final AdobeCallback<Map<String, Object>> callback);
Copied to your clipboard
public static void getConsents(final AdobeCallback<Map<String, Object>> callback);

callback - callback invoked with the current consents of the extension. If an AdobeCallbackWithError is provided, an AdobeError, can be returned in the eventuality of any error that occurred while getting the user consents. The callback may be invoked on a different thread.

Example

Consent.getConsents(new AdobeCallback<Map<String, Object>>() {
    @Override
    public void call(Map<String, Object> currentConsents) {
        // Handle currentConsents
    }
});
Copied to your clipboard
Consent.getConsents(new AdobeCallback<Map<String, Object>>() {
    @Override
    public void call(Map<String, Object> currentConsents) {
        // Handle currentConsents
    }
});

Kotlin

Example

Consent.getConsents { currentConsents ->
    // Handle currentConsents
}
Copied to your clipboard
Consent.getConsents { currentConsents ->
    // Handle currentConsents
}

iOS

Swift

Syntax

static func getConsents(completion: @escaping ([String: Any]?, Error?) -> Void)
Copied to your clipboard
static func getConsents(completion: @escaping ([String: Any]?, Error?) -> Void)

completion - Invoked with the current consent preferences or an AEPError if an unexpected error occurs or the request timed out. It may be invoked on a different thread.

Example

Consent.getConsents { currentConsents, error in
    // Handle currentConsents
}
Copied to your clipboard
Consent.getConsents { currentConsents, error in
    // Handle currentConsents
}

Objective-C

Syntax

+ (void) getConsents:^ (NSDictionary<NSString *,id> * _Nullable, NSError * _Nullable)
Copied to your clipboard
+ (void) getConsents:^ (NSDictionary<NSString *,id> * _Nullable, NSError * _Nullable)

Example

[AEPMobileEdgeConsent getConsents:^(NSDictionary *currentConsents, NSError *error){
    // Handle currentConsents
}];
Copied to your clipboard
[AEPMobileEdgeConsent getConsents:^(NSDictionary *currentConsents, NSError *error){
    // Handle currentConsents
}];

Java

Syntax

public static void getConsents(final AdobeCallback<Map<String, Object>> callback);
Copied to your clipboard
public static void getConsents(final AdobeCallback<Map<String, Object>> callback);

callback - callback invoked with the current consents of the extension. If an AdobeCallbackWithError is provided, an AdobeError, can be returned in the eventuality of any error that occurred while getting the user consents. The callback may be invoked on a different thread.

Example

Consent.getConsents(new AdobeCallback<Map<String, Object>>() {
    @Override
    public void call(Map<String, Object> currentConsents) {
        // Handle currentConsents
    }
});
Copied to your clipboard
Consent.getConsents(new AdobeCallback<Map<String, Object>>() {
    @Override
    public void call(Map<String, Object> currentConsents) {
        // Handle currentConsents
    }
});

Kotlin

Example

Consent.getConsents { currentConsents ->
    // Handle currentConsents
}
Copied to your clipboard
Consent.getConsents { currentConsents ->
    // Handle currentConsents
}

Swift

Syntax

static func getConsents(completion: @escaping ([String: Any]?, Error?) -> Void)
Copied to your clipboard
static func getConsents(completion: @escaping ([String: Any]?, Error?) -> Void)

completion - Invoked with the current consent preferences or an AEPError if an unexpected error occurs or the request timed out. It may be invoked on a different thread.

Example

Consent.getConsents { currentConsents, error in
    // Handle currentConsents
}
Copied to your clipboard
Consent.getConsents { currentConsents, error in
    // Handle currentConsents
}

Objective-C

Syntax

+ (void) getConsents:^ (NSDictionary<NSString *,id> * _Nullable, NSError * _Nullable)
Copied to your clipboard
+ (void) getConsents:^ (NSDictionary<NSString *,id> * _Nullable, NSError * _Nullable)

Example

[AEPMobileEdgeConsent getConsents:^(NSDictionary *currentConsents, NSError *error){
    // Handle currentConsents
}];
Copied to your clipboard
[AEPMobileEdgeConsent getConsents:^(NSDictionary *currentConsents, NSError *error){
    // Handle currentConsents
}];

registerExtension

This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.

Use MobileCore.registerExtensions() API instead.

Android

Java

Syntax

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

Example

Consent.registerExtension();
Copied to your clipboard
Consent.registerExtension();

Java

Syntax

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

Example

Consent.registerExtension();
Copied to your clipboard
Consent.registerExtension();

updateConsents

Merges the existing consents with the given consents. Duplicate keys will take the value of those passed in the API.

Android

Java

Syntax

public static void update(final Map<String, Object> consents);
Copied to your clipboard
public static void update(final Map<String, Object> consents);

consents - A Map of consents defined based on Privacy/Personalization/Marketing Preferences (Consents) XDM Schema.

Example

// Example 1, updating users collect consent to 'yes'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "y");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);

// Example 2, updating users collect consent to 'no'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "n");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "y");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);

// Example 2, updating users collect consent to 'no'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "n");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);

Kotlin

Example

// Example 1, updating users collect consent to 'yes'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "y")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)

// Example 2, updating users collect consent to 'no'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "n")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "y")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)

// Example 2, updating users collect consent to 'no'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "n")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)

iOS

Swift

Syntax

static func update(with consents: [String: Any])
Copied to your clipboard
static func update(with consents: [String: Any])

consents - A [String: Any] of consents defined based on Privacy/Personalization/Marketing Preferences (Consents) XDM Schema.

Example

// Example 1, updating users collect consent to 'yes'
let collectConsent = ["collect": ["val": "y"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

// Example 2, updating users collect consent to 'no'
let collectConsent = ["collect": ["val": "n"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
let collectConsent = ["collect": ["val": "y"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

// Example 2, updating users collect consent to 'no'
let collectConsent = ["collect": ["val": "n"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

Objective-C

Syntax

+ (void) updateWithConsents:(NSDictionary<NSString *,id> * _Nonnull)
Copied to your clipboard
+ (void) updateWithConsents:(NSDictionary<NSString *,id> * _Nonnull)

Example

// Example 1, updating users collect consent to 'yes'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"y"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];

// Example 2, updating users collect consent to 'no'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"n"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"y"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];

// Example 2, updating users collect consent to 'no'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"n"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];

Java

Syntax

public static void update(final Map<String, Object> consents);
Copied to your clipboard
public static void update(final Map<String, Object> consents);

consents - A Map of consents defined based on Privacy/Personalization/Marketing Preferences (Consents) XDM Schema.

Example

// Example 1, updating users collect consent to 'yes'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "y");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);

// Example 2, updating users collect consent to 'no'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "n");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "y");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);

// Example 2, updating users collect consent to 'no'
final Map<String, Object> collectConsents = new HashMap<>();
collectConsents.put("collect", new HashMap<String, String>() {
    {
        put("val", "n");
    }
});

final Map<String, Object> consents = new HashMap<>();
consents.put("consents", collectConsents);

Consent.update(consents);

Kotlin

Example

// Example 1, updating users collect consent to 'yes'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "y")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)

// Example 2, updating users collect consent to 'no'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "n")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "y")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)

// Example 2, updating users collect consent to 'no'
val collectConsents = mutableMapOf<String, Any>()
collectConsents["collect"] = mutableMapOf("val" to "n")

val consents = mutableMapOf<String, Any>()
consents["consents"] = collectConsents

Consent.update(consents)

Swift

Syntax

static func update(with consents: [String: Any])
Copied to your clipboard
static func update(with consents: [String: Any])

consents - A [String: Any] of consents defined based on Privacy/Personalization/Marketing Preferences (Consents) XDM Schema.

Example

// Example 1, updating users collect consent to 'yes'
let collectConsent = ["collect": ["val": "y"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

// Example 2, updating users collect consent to 'no'
let collectConsent = ["collect": ["val": "n"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
let collectConsent = ["collect": ["val": "y"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

// Example 2, updating users collect consent to 'no'
let collectConsent = ["collect": ["val": "n"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

Objective-C

Syntax

+ (void) updateWithConsents:(NSDictionary<NSString *,id> * _Nonnull)
Copied to your clipboard
+ (void) updateWithConsents:(NSDictionary<NSString *,id> * _Nonnull)

Example

// Example 1, updating users collect consent to 'yes'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"y"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];

// Example 2, updating users collect consent to 'no'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"n"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];
Copied to your clipboard
// Example 1, updating users collect consent to 'yes'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"y"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];

// Example 2, updating users collect consent to 'no'
NSDictionary *collectConsent = @{ @"collect": @{@"val": @"n"};
[AEPMobileEdgeConsent updateWithConsents:@{@"consents": collectConsent}];

When Consent.update API is called, the Consent extension uses Adobe Standard 2.0 to communicate with the Edge Network. Additionally, the property metadata is set to the time at which the API is called.

The following example shows when Consent.update is called to set collect consent to y:

// Example in iOS (Swift),  updating user's collect consent to 'yes'
let collectConsent = ["collect": ["val": "y"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)
Copied to your clipboard
// Example in iOS (Swift),  updating user's collect consent to 'yes'
let collectConsent = ["collect": ["val": "y"]]
let currentConsents = ["consents": collectConsent]
Consent.update(with: currentConsents)

Bellow you can see the snippet of the request payload sent to the Edge Network:

    "consent": [
        {
        "standard": "Adobe",
        "version": "2.0",
        "value": {
            "metadata": {
            "time" : "2023-10-03T17:23:04.443Z"
            },
            "collect": {
            "val": "y"
            }
          }
        }
     ]
Copied to your clipboard
    "consent": [
        {
        "standard": "Adobe",
        "version": "2.0",
        "value": {
            "metadata": {
            "time" : "2023-10-03T17:23:04.443Z"
            },
            "collect": {
            "val": "y"
            }
          }
        }
     ]

For additional information about the management of consent preferences, please refer to the Privacy and GDPR documentation.

Overview

Release notes

Last updated 4/5/2024

Was this helpful?

Yes

API Reference

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

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

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

getConsents

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

registerExtension

Java

Java

updateConsents

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

extensionVersion

Java