Java

Example

String audienceExtensionVersion = Audience.extensionVersion();
Copied to your clipboard
String audienceExtensionVersion = Audience.extensionVersion();

Swift

Syntax

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

Example

let audienceExtensionVersion  = ACPAudience.extensionVersion()
Copied to your clipboard
let audienceExtensionVersion  = ACPAudience.extensionVersion()

Objective-C

Syntax

add
Copied to your clipboard
add

Example

NSString *audienceExtensionVersion = [ACPAudience extensionVersion];
Copied to your clipboard
NSString *audienceExtensionVersion = [ACPAudience extensionVersion];

JavaScript

Example

ACPAudience.extensionVersion().then(audienceExtensionVersion => console.log("AdobeExperienceSDK: ACPAudience version: " + audienceExtensionVersion));
Copied to your clipboard
ACPAudience.extensionVersion().then(audienceExtensionVersion => console.log("AdobeExperienceSDK: ACPAudience version: " + audienceExtensionVersion));

Dart

Example

String audienceExtensionVersion = await FlutterACPAudience.extensionVersion;
Copied to your clipboard
String audienceExtensionVersion = await FlutterACPAudience.extensionVersion;

Cordova

Example

ACPAudience.extensionVersion(function(version) {  
   console.log("ACPAudience version: " + version);
}, function(error) {  
   console.log(error);  
});
Copied to your clipboard
ACPAudience.extensionVersion(function(version) {  
   console.log("ACPAudience version: " + version);
}, function(error) {  
   console.log(error);  
});

C#

Example

string audienceExtensionVersion = ACPAudience.ExtensionVersion();
Copied to your clipboard
string audienceExtensionVersion = ACPAudience.ExtensionVersion();

C#

Example

string audienceExtensionVersion = ACPAudience.ExtensionVersion();
Copied to your clipboard
string audienceExtensionVersion = ACPAudience.ExtensionVersion();

This API returns the most recently obtained visitor profile. For easy access across multiple launches of your app, the visitor profile is saved in SharedPreferences. If no signal has been submitted, null is returned.

When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with the visitor profile.

Java

Syntax

public static void getVisitorProfile(final AdobeCallback<Map<String, String>> adobeCallback)
Copied to your clipboard
public static void getVisitorProfile(final AdobeCallback<Map<String, String>> adobeCallback)

Example

AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // your own customized code
    }
};

Audience.getVisitorProfile(visitorProfileCallback);
Copied to your clipboard
AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // your own customized code
    }
};

Audience.getVisitorProfile(visitorProfileCallback);

The getVisitorProfile API returns the most recently obtained visitor profile. For easy access across multiple launches of your app, the visitor profile is saved in NSUserDefaults. If no signal has been submitted, nil is returned.

The getVisitorProfileWithCompletionHandler method was added in ACPAudience version 2.1.0.

Swift

Syntax

static func getVisitorProfile(_ callback: @escaping ([AnyHashable : Any]?) -> Void)

static func getVisitorProfile(completionHandler: @escaping ([AnyHashable : Any]?, Error?) -> Void)
Copied to your clipboard
static func getVisitorProfile(_ callback: @escaping ([AnyHashable : Any]?) -> Void)

static func getVisitorProfile(completionHandler: @escaping ([AnyHashable : Any]?, Error?) -> Void)

Example

ACPAudience.getVisitorProfile { (visitorProfile) in
  // handle the visitorProfile here
}

ACPAudience.getVisitorProfile { (visitorProfile, error) in
  if let error = error {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}
Copied to your clipboard
ACPAudience.getVisitorProfile { (visitorProfile) in
  // handle the visitorProfile here
}

ACPAudience.getVisitorProfile { (visitorProfile, error) in
  if let error = error {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}

Objective-C

Syntax

+ (void) getVisitorProfile: (nonnull void (^) (NSDictionary* __nullable visitorProfile)) callback;

+ (void) getVisitorProfileWithCompletionHandler: (nonnull void (^) (NSDictionary* __nullable visitorProfile, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getVisitorProfile: (nonnull void (^) (NSDictionary* __nullable visitorProfile)) callback;

+ (void) getVisitorProfileWithCompletionHandler: (nonnull void (^) (NSDictionary* __nullable visitorProfile, NSError* __nullable error)) completionHandler;

Example

[ACPAudience getVisitorProfile:^(NSDictionary* visitorProfile){
  // handle the visitorProfile here
}];

[ACPAudience getVisitorProfileWithCompletionHandler:^(NSDictionary * _Nullable visitorProfile, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}];
Copied to your clipboard
[ACPAudience getVisitorProfile:^(NSDictionary* visitorProfile){
  // handle the visitorProfile here
}];

[ACPAudience getVisitorProfileWithCompletionHandler:^(NSDictionary * _Nullable visitorProfile, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}];

JavaScript

Example

ACPAudience.getVisitorProfile().then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));
Copied to your clipboard
ACPAudience.getVisitorProfile().then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));

Java

Syntax

public  static void registerExtension() throws InvalidInitException
Copied to your clipboard
public  static void registerExtension() throws InvalidInitException

Example

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

Swift

Syntax

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

Example

ACPAudience.registerExtension()
Copied to your clipboard
ACPAudience.registerExtension()

Objective-C

Syntax

+ (BOOL) registerExtension: (nonnull Class) extensionClass
                     error: (NSError* _Nullable* _Nullable) error;
Copied to your clipboard
+ (BOOL) registerExtension: (nonnull Class) extensionClass
                     error: (NSError* _Nullable* _Nullable) error;

Example

[ACPAudience registerExtension];
Copied to your clipboard
[ACPAudience registerExtension];

JavaScript

Example

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

This API resets the Audience Manager UUID and purges the current visitor profile from android.content.SharedPreferences. The Audience reset also clears the current in-memory DPID and DPUUID variables.

Java

Syntax

public static void reset()
Copied to your clipboard
public static void reset()

Example

Audience.reset();
Copied to your clipboard
Audience.reset();

The reset API resets the Audience Manager UUID and purges the current visitor profile from UserDefaults. The Audience reset also clears the current in-memory DPID and DPUUID variables.

Swift

Syntax

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

Example

ACPAudience.reset()
Copied to your clipboard
ACPAudience.reset()

Objective-C

Syntax

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

Example

[ACPAudience reset];
Copied to your clipboard
[ACPAudience reset];

JavaScript

Example

ACPAudience.reset();
Copied to your clipboard
ACPAudience.reset();

The signalWithData API sends Audience Manager a signal with traits and returns the matching segments for the visitor in a callback.

Audience Manager sends the AAM UUID in response in initial signal call. The AAM UUID is persisted in SharedPreferences and is sent by the SDK in all subsequent signal requests. If available, the ECID is also sent in each signal request with the DPID and the DPUUID. The visitor profile that Audience Manager returns is saved in SharedPreferences and is updated with every signal call.

When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with the visitor profile.

Java

Syntax

public static void signalWithData(final Map<String, String> data, final AdobeCallback<Map<String, String>> callback)
Copied to your clipboard
public static void signalWithData(final Map<String, String> data, final AdobeCallback<Map<String, String>> callback)

data is the traits data for the current visitor.
callback is the void method that is invoked with the visitor's profile as a parameter.

Example

AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // handle the returned visitorProfile here
    }
};

Map<String, String> traits = new HashMap<String, String>();
traits.put("trait", "xyz");
Audience.signalWithData(traits, visitorProfileCallback);
Copied to your clipboard
AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // handle the returned visitorProfile here
    }
};
Map<String, String> traits = new HashMap<String, String>();
traits.put("trait", "xyz");
Audience.signalWithData(traits, visitorProfileCallback);

The signalWithData API sends Audience Manager a signal with traits and returns the matching segments for the visitor in a callback.

Audience Manager sends the AAM UUID in response in initial signal call. The AAM UUID is persisted in NSUserDefaults and is sent by the SDK in all subsequent signal requests. If available, the Experience Cloud ID (MID) is also sent in each signal request with the DPID and the DPUUID. The visitor profile that Audience Manager returns is saved in NSUserDefaults and is updated with every signal call.

Please note that the signalWithData:withCompletionHandler method was added in ACPAudience version 2.1.0.

Swift

Syntax

static func signal(withData data: [String : String]?, callback: (([AnyHashable : Any]?) -> Void)? = nil)

static func signal(withData data: [String : String], withCompletionHandler completionHandler: @escaping ([AnyHashable : Any]?, Error?) -> Void)
Copied to your clipboard
static func signal(withData data: [String : String]?, callback: (([AnyHashable : Any]?) -> Void)? = nil)

static func signal(withData data: [String : String], withCompletionHandler completionHandler: @escaping ([AnyHashable : Any]?, Error?) -> Void)

Example

ACPAudience.signal(withData: ["key1": "value1", "key2": "value2"], callback: { (visitorProfile) in
  // handle the visitorProfile here  
})

ACPAudience.signal(withData: ["key1": "value1", "key2": "value2"], withCompletionHandler: { (visitorProfile, error) in
  if let error = error {
    // handle error
  } else {
    // handle the returned visitorProfile here
  }    
})
Copied to your clipboard
ACPAudience.signal(withData: ["key1": "value1", "key2": "value2"], callback: { (visitorProfile) in
  // handle the visitorProfile here  
})

ACPAudience.signal(withData: ["key1": "value1", "key2": "value2"], withCompletionHandler: { (visitorProfile, error) in
  if let error = error {
    // handle error
  } else {
    // handle the returned visitorProfile here
  }    
})

Objective-C

Syntax

+ (void) signalWithData: (NSDictionary<NSString*, NSString*>* __nullable) data
                       callback: (nullable void (^) (NSDictionary* __nullable visitorProfile)) callback;

+ (void) signalWithData: (NSDictionary<NSString*, NSString*>* __nullable) data
                        withCompletionHandler:: (nullable void (^) (NSDictionary* __nullable visitorProfile, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) signalWithData: (NSDictionary<NSString*, NSString*>* __nullable) data
                       callback: (nullable void (^) (NSDictionary* __nullable visitorProfile)) callback;

+ (void) signalWithData: (NSDictionary<NSString*, NSString*>* __nullable) data
                        withCompletionHandler:: (nullable void (^) (NSDictionary* __nullable visitorProfile, NSError* __nullable error)) completionHandler;

data is the traits data for the current visitor.
callback is the void method that is invoked with the visitor's profile as a parameter.

Example

NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[ACPAudience signalWithData:traits callback:^(NSDictionary* _Nullable visitorProfile){
  // handle the returned visitorProfile dictionary here
}];

[ACPAudience signalWithData:traits withCompletionHandler:^(NSDictionary * _Nullable visitorProfile, NSError * _Nullable error) {
  if (error) {
    // handle the error here
  } else {
    // handle the returned visitorProfile dictionary here
  }
}];
Copied to your clipboard
NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[ACPAudience signalWithData:traits callback:^(NSDictionary* _Nullable visitorProfile){
  // handle the returned visitorProfile dictionary here
}];

[ACPAudience signalWithData:traits withCompletionHandler:^(NSDictionary * _Nullable visitorProfile, NSError * _Nullable error) {
  if (error) {
    // handle the error here
  } else {
    // handle the returned visitorProfile dictionary here
  }
}];

JavaScript

Example

ACPAudience.signalWithData({"yourDataKey": "yourDataValue"}).then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));
Copied to your clipboard
ACPAudience.signalWithData({"yourDataKey": "yourDataValue"}).then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));

Home

Was this helpful?

Yes

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

Swift

Objective-C

JavaScript

Dart

Cordova

C#

C#

Java

Swift

Objective-C

JavaScript

Java

Swift

Objective-C

JavaScript

Java

Swift

Objective-C

JavaScript

Java

Swift

Objective-C

JavaScript

Java