Syntax

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

Example

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

Syntax

Copy
fun extensionVersion(): String
Copied to your clipboard
fun extensionVersion(): String

Example

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

Syntax

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

Example

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

Syntax

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

Example

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

Syntax

Copy
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 - Invoked with the current consent preferences. If an AdobeCallbackWithError is provided, an AdobeError is returned if any error occurs while retrieving the user consents. The callback may be invoked on a different thread.

Example

Copy
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
    }
});

Syntax

Copy
fun getConsents(callback: AdobeCallback<Map<String, Any>>)
Copied to your clipboard
fun getConsents(callback: AdobeCallback<Map<String, Any>>)

• callback - Invoked with the current consent preferences. If an AdobeCallbackWithError is provided, an AdobeError is returned if any error occurs while retrieving the user consents. The callback may be invoked on a different thread.

Example

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

Syntax

Copy
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 error occurs or the request times out. The completion may be invoked on a different thread.

Example

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

Syntax

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

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

Example

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

Syntax

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

Example

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

Use the MobileCore API to register the Edge Consent extension.

Syntax

Copy
static func registerExtensions(_ extensions: [NSObject.Type], 
                               _ completion: (() -> Void)? = nil)
Copied to your clipboard
static func registerExtensions(_ extensions: [NSObject.Type], 
                               _ completion: (() -> Void)? = nil)

Example

Copy
import AEPEdgeConsent

...
MobileCore.registerExtensions([Consent.self])
Copied to your clipboard
import AEPEdgeConsent

...
MobileCore.registerExtensions([Consent.self])

Use the AEPMobileCore API to register the Edge Consent extension.

Syntax

Copy
+ (void) registerExtensions: (NSArray<Class*>* _Nonnull) extensions 
                  completion: (void (^ _Nullable)(void)) completion;
Copied to your clipboard
+ (void) registerExtensions: (NSArray<Class*>* _Nonnull) extensions 
                  completion: (void (^ _Nullable)(void)) completion;

Example

Copy
@import AEPEdgeConsent;

...
[AEPMobileCore registerExtensions:@[AEPMobileEdgeConsent.class] completion:nil];
Copied to your clipboard
@import AEPEdgeConsent;

...
[AEPMobileCore registerExtensions:@[AEPMobileEdgeConsent.class] completion:nil];

Syntax

Copy
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

Copy
// 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);

Syntax

Copy
fun update(consents: Map<String, Any>)
Copied to your clipboard
fun update(consents: Map<String, Any>)

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

Example

Copy
// 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)

Syntax

Copy
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

Copy
// 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)

Syntax

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

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

Example

Copy
// 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}];

Last updated 8/16/2025

Was this helpful?

Yes

No