Skip to content

Latest commit

 

History

History
2577 lines (1862 loc) · 59.6 KB

mobile-core-api-reference.md

File metadata and controls

2577 lines (1862 loc) · 59.6 KB

Mobile Core API reference

collectLaunchInfo

You can provide the user information to the SDK from various launch points in your application.

{% hint style="info" %} If the Adobe Analytics extension is enabled in your SDK, collecting this launch data results in an Analytics request being sent. Other extensions in the SDK might use the collected data, for example, as a rule condition for an In-App Message. {% endhint %}

{% tabs %} {% tab title="Android" %} The Android SDK automatically registers an Application.ActivityLifecycleCallbacksand listens for onActivityResumed. When an activity is resumed, SDK collects the data from the activity. Currently, it is being used in the following scenarios:

  • Tracking deep link clickthrough
  • Tracking push message clickthrough
  • Tracking Local Notification clickthrough {% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

This method should be called to support the following use cases:

  • Tracking deep link clickthroughs
    • From application(_:didFinishLaunchingWithOptions:)
    • Extract userInfo from url: UIApplication.LaunchOptionsKey
  • Tracking push message clickthrough
    • From application(_:didReceiveRemoteNotification:fetchCompletionHandler:)

Syntax

 public static func collectLaunchInfo(_ userInfo: [String: Any])

Example

 MobileCore.collectLaunchInfo(userInfo)

Objective-C

This method should be called to support the following use cases:

  • Tracking deep link clickthroughs
    • From application:didFinishLaunchingWithOptions
    • Extract userInfo from UIApplicationLaunchOptionsURLKey
      • Tracking push message clickthrough
    • From application:didReceiveRemoteNotification:fetchCompletionHandler:

Syntax

@objc(collectLaunchInfo:)
public static func collectLaunchInfo(_ userInfo: [String: Any])

Example

 [AEPMobileCore collectLaunchInfo:launchOptions];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

The collectLaunchInfo method should be used in the following use cases:

  • Tracking a deep link clickthrough
    • From application:didFinishLaunchingWithOptions
    • Extract userInfo from UIApplicationLaunchOptionsURLKey
  • Tracking a push message clickthrough
    • From application:didReceiveRemoteNotification:fetchCompletionHandler:

Syntax

(void) collectLaunchInfo: (nonnull NSDictionary*) userInfo;

Example

 [ACPCore collectLaunchInfo:launchOptions];

Swift

The collectLaunchInfo method should be used in the following use cases:

  • Tracking a deep link clickthrough
    • From application(_:didFinishLaunchingWithOptions:)
    • Extract userInfo from url: UIApplication.LaunchOptionsKey
  • Tracking a push message clickthrough
    • From application(_:didReceiveRemoteNotification:fetchCompletionHandler:)

Syntax

(void) collectLaunchInfo: (nonnull NSDictionary*) userInfo;

Example

AEPCore.collectLaunchInfo(userInfo)

{% endtab %} {% endtabs %}

collectPii

The collectPii method lets the SDK to collect sensitive or personally identifiable information (PII).

{% hint style="warning" %} Although this method enables the collection of sensitive data, no data is sent to any Adobe or other third-party endpoints. To send the data to an endpoint, use a PII type postback. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

Syntax

public static void collectPII(final Map<String, String> piiData);

Example

Map<String, String> data = new HashMap<String, String>();
data.put("firstname", "customer");
//The rule to trigger a PII needs to be setup for this call
//to result in a network send
MobileCore.collectPII(data);

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

public static func collectPii(_ data: [String: Any])

Example

MobileCore.collectPii(["key1" : "value1","key2" : "value2"]);

Objective-C

Syntax

 @objc(collectPii:)
 public static func collectPii(_ data: [String: Any])

Example

 [AEPMobileCore collectPii:data:@{@"key1" : @"value1",
                            @"key2" : @"value2"
                            }];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

(void) collectPii: (nonnull NSDictionary<NSString*, NSString*>*) data;

Example

[ACPCore collectPii:data:@{@"key1" : "@value1",
                           @"key2" : "@value2"
                           }];

Swift

Syntax

ACPCore.collectPii(data: [String : String])

Example

MobileCore.collectPii(["key1" : "value1","key2" : "value2"]);

{% endtab %}

{% tab title="React Native" %} Javascript

Syntax

ACPCore.collectPii(data: [String : String])

Example

ACPCore.collectPii({"myPii": "data"});

Swift

Syntax

ACPCore.collectPii(data: [String : String])

Example

MobileCore.collectPii(["key1" : "value1","key2" : "value2"]);

{% endtab %} {% endtabs %}

getApplication (Android only)

You can use the getApplication method to get the previously set Android Application instance. The Application instance is mainly provided for third-party extensions.

{% tabs %} {% tab title="Android" %} Java

{% hint style="warning" %} MobileCore.getApplication will return null if the Application object was destroyed or if MobileCore.setApplication was not previously called. {% endhint %}

Syntax

public static Application getApplication()

Example

Application app = MobileCore.getApplication();
if (app != null) {
    ...
}

{% endtab %}

{% tab title="Xamarin" %} C#

{% hint style="warning" %} ACPCore.Application may be null if the Application object was destroyed or was not set in the Core. {% endhint %}

Example

var app = ACPCore.Application;
if (app != null) {
    ...
}

{% endtab %} {% endtabs %}

getLogLevel

This API gets the current log level being used in the SDK.

{% tabs %} {% tab title="Android" %} Java

Syntax

public static LoggingMode getLogLevel()

Example

LoggingMode mode = MobileCore.getLogLevel();

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Note, the logLevel getter has been deprecated. There is a new API to get the log level in the Swift AEP 3.x SDKs:

Log.logFilter

Syntax

public static var logFilter: LogLevel

This variable is part of the Log class within AEPServices.

Example

var logLevel = Log.logFilter

Objective-C

Note, the logLevel getter has been deprecated. There is a new API to get the log level in the Swift AEP 3.x SDKs:

Log.logFilter

Syntax

@objc public static var logFilter: LogLevel

Example

AEPLogLevel logLevel = [AEPLog logFilter];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

getLogLevel

Syntax

(ACPMobileLogLevel) logLevel;

Example

var logLevel:ACPMobileLogLevel = [ACPCore logLevel];

Swift

getLogLevel

Syntax

(ACPMobileLogLevel) logLevel;

Example

let logLevel:ACPMobileLogLevel = ACPCore.logLevel();

{% endtab %}

{% tab title="React Native" %} Javascript

getLogLevel

Example

ACPCore.getLogLevel().then(level => console.log("AdobeExperienceSDK: Log Level = " + level));

{% endtab %}

{% tab title="Unity" %} C#

getLogLevel

Example

ACPCore.ACPMobileLogLevel logLevel = ACPCore.GetLogLevel();

{% endtab %}

{% tab title="Xamarin" %} C#

getLogLevel

Example

var logLevel = ACPCore.LogLevel;

{% endtab %} {% endtabs %}

getSdkIdentities

The following SDK identities, as applicable, are locally stored:

  • Company Context - IMS Org IDs
  • Experience Cloud ID (MID)
  • User IDs
  • Integration codes (ADID, push IDs)
  • Data source IDs (DPID, DPUUID)
  • Analytics IDs (AVID, AID, VID, and associated RSIDs)
  • Target legacy IDs (TNTID, TNT3rdpartyID)
  • Audience Manager ID (UUID)

To retrieve data as a JSON string from the SDKs and send this data to your servers, use the getSdkIdentities method:

{% hint style="warning" %} You must call the API below and retrieve identities stored in the SDK, before the user opts out.

This API does not include the identities stored in the Edge Identity extension. To retrieve the identities from the Edge Identity extension, use getIdentities. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

Syntax

void getSdkIdentities(AdobeCallback<String> callback);
  • callback is invoked with the SDK identities as a JSON string.
    • If an instance of AdobeCallbackWithError is provided, and you are fetching the attributes from the Mobile SDK, the timeout value is 5000ms. If the operation times out or an unexpected error occurs, the fail method is called with the appropriate AdobeError.

Example

MobileCore.getSdkIdentities(new AdobeCallback<String>() {
    @Override
    public void call(String value) {
        // handle the json string
    }
});

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

static func getSdkIdentities(completion: @escaping (String?, Error?) -> Void)
  • callback is invoked with the SDK identities as a JSON string.
  • completionHandler is invoked with the SDK identities as a JSON string, or error if an unexpected error occurs or the request times out. The default timeout is 1000ms.

Example

 MobileCore.getSdkIdentities { (content, error) in
     // handle completion
 }

Objective-C

Syntax

 @objc(getSdkIdentities:)
 static func getSdkIdentities(completion: @escaping (String?, Error?) -> Void)
  • callback is invoked with the SDK identities as a JSON string.
  • completionHandler is invoked with the SDK identities as a JSON string, or error if an unexpected error occurs or the request times out. The default timeout is 1000ms.

Example

Objective-C

 [AEPMobileCore getSdkIdentities:^(NSString * _Nullable content, NSError * _Nullable error) {
     if (error) {
       // handle error here
     } else {
       // handle the retrieved identities
     }
 }];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

(void) getSdkIdentities: (nullable void (^) (NSString* __nullable content)) callback;
(void) getSdkIdentitiesWithCompletionHandler: (nullable void (^) (NSString* __nullable content, NSError* _Nullable error)) completionHandler;
  • callback is invoked with the SDK identities as a JSON string.
  • completionHandler is invoked with the SDK identities as a JSON string, or error if an unexpected error occurs or the request times out. The default timeout is 1000ms.

Example

[ACPCore getSdkIdentities:^(NSString * _Nullable content){
    NSLog(content);

[ACPCore getSdkIdentitiesWithCompletionHandler:^(NSString * _Nullable content, NSError * _Nullable error) {
        if (error) {
            // handle error here
        } else {
            // handle the retrieved identities
            NSLog(content);
        }
    }];

Swift

MobileCore.getSdkIdentities { (content, error) in
    // handle completion
}

{% endtab %} {% endtabs %}

log

This is the API used to log from the SDK.

{% tabs %} {% tab title="Android" %} Java

The MobileCore logging APIs use the android.util.Log APIs to log messages to Android. Based on the LoggingMode that is passed to MobileCore.log(), the following Android method is called:

  • LoggingMode.VERBOSE uses android.util.Log.v
  • LoggingMode.DEBUG uses android.util.Log.d
  • LoggingMode.WARNING uses android.util.Log.w
  • LoggingMode.ERROR uses android.util.Log.e

All log messages from the Adobe Experience SDK to Android use the same log tag of AdobeExperienceSDK. For example, if logging an error message is using MobileCore.log(), the call to android.util.Log.e looks like Log.e("AdobeExperienceSDK", tag + " - " + message).

Syntax

public static void log(final LoggingMode mode, final String tag, final String message)

Example

MobileCore.log(LoggingMode.DEBUG, "MyClassName", "Provided data was null");

Output

D/AdobeExperienceSDK: MyClassName - Provided data was null

{% endtab %}

{% tab title="iOS (AEP 3.x)" %}

Swift

The log messages from the Adobe Experience SDK are printed to the Apple System Log facility and use a common format that contains the tag AEP SDK. For example, if logging an error message using Log.error(label:_ message:_), the printed output looks like [AEP SDK ERROR <label>]: message.

Syntax

public static func trace(label: String, _ message: String) {
public static func debug(label: String, _ message: String)
public static func warning(label: String, _ message: String) {
public static func error(label: String, _ message: String) {

Example

Log.trace(label: "testLabel", "Test message")
Log.debug(label: "testLabel", "Test message")
Log.warning(label: "testLabel", "Test message")
Log.error(label: "testLabel", "Test message")

Objective-C

The log messages from the Adobe Experience SDK are printed to the Apple System Log facility and use a common format that contains the tag AEP SDK. For example, if logging an error message using [AEPLog errorWithLabel: _ message:_], the printed output looks like [AEP SDK ERROR <label>]: message.

Syntax

@objc(traceWithLabel:message:)
public static func trace(label: String, _ message: String) 

@objc(debugWithLabel:message:)
public static func debug(label: String, _ message: String) 

@objc(warningWithLabel:message:)
public static func warning(label: String, _ message: String) 

@objc(errorWithLabel:message:)
public static func error(label: String, _ message: String)

Example

[AEPLog traceWithLabel:@"testLabel" message:@"testMessage"];
[AEPLog debugWithLabel:@"testLabel" message:@"testMessage"];
[AEPLog warningWithLabel:@"testLabel" message:@"testMessage"];
[AEPLog errorWithLabel:@"testLabel" message:@"testMessage"];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

The log messages from the Adobe Experience SDK are printed to the Apple System Log facility and use a common format that contains the tag AdobeExperienceSDK. For example, if logging an error message using ACPCore.log(), the printed output looks like [AdobeExperienceSDK ERROR <tag>]: message[AEP SDK ERROR - <testLabel>] Test message.

Syntax

+ (void) log: (ACPMobileLogLevel) logLevel tag: (nonnull NSString*) tag message: (nonnull NSString*) message;

Example

[ACPCore log: ACPMobileLogLevelDebug, tag:@"MyClassName", message:@"Provided data was nil"];

Output example

[AdobeExperienceSDK DEBUG <MyClassName>]: Provided data was nil

Swift

Syntax

+ (void) log: (ACPMobileLogLevel) logLevel tag: (nonnull NSString*) tag message: (nonnull NSString*) message;

Example

ACPCore.log(ACPMobileLogLevel.debug, tag: "MyClassName", message: "Provided data was nil");

Output example

[AdobeExperienceSDK DEBUG <MyClassName>]: Provided data was nil

{% endtab %}

{% tab title="React Native" %}

JavaScript

The log messages from the Adobe Experience SDK are printed to the Log facility and use a common format that contains the tag ACPMobileLogLevel.

Example

ACPCore.log(ACPMobileLogLevel.ERROR, "React Native Tag", "React Native Message");

Note: ACPMobileLogLevel contains the following getters:

const ERROR = "ACP_LOG_LEVEL_ERROR";
const WARNING = "ACP_LOG_LEVEL_WARNING";
const DEBUG = "ACP_LOG_LEVEL_DEBUG";
const VERBOSE = "ACP_LOG_LEVEL_VERBOSE";

{% endtab %}

{% tab title="Xamarin" %}

C#

The log messages from the Adobe Experience SDK are printed to the Log facility and use a common format that contains the tag AdobeExperienceSDK.

iOS syntax

ACPCore.Log(ACPMobileLogLevel.Error, "xamarin tag", "xamarin message");
[AdobeExperienceSDK ERROR <xamarin tag>]: xamarin message

Android syntax

ACPCore.Log(LoggingMode.Error, "xamarin tag", "xamarin message");
[AdobeExperienceSDK] xamarin tag - xamarin message

{% endtab %} {% endtabs %}

registerExtension(s)

Extensions are registered with Mobile Core so that they can dispatch and listen for events.

{% hint style="danger" %} Extension registration is mandatory. Attempting to make extension-specific API calls without registering the extension will lead to undefined behavior. {% endhint %}

The following code snippets demonstrate how you can import and register the Mobile Core and Profile extensions. You can also see, for reference, how Identity, Lifecycle, Signal, Profile, and other extensions are imported and registered.

{% tabs %} {% tab title="Android" %} After you register the extensions, call the start API in Mobile Core to initialize the SDK as shown below. This step is required to boot up the SDK for event processing. The following code snippet is provided as a sample reference.

Java

import com.adobe.marketing.mobile.AdobeCallback;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.InvalidInitException;
import com.adobe.marketing.mobile.Lifecycle;
import com.adobe.marketing.mobile.LoggingMode;
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Signal;
import com.adobe.marketing.mobile.UserProfile;
...
import android.app.Application;
...
public class MainApp extends Application {
  ...
  @Override
  public void on Create(){
    super.onCreate();
    MobileCore.setApplication(this);
        MobileCore.setLogLevel(LoggingMode.DEBUG);
    ...
    try {
      UserProfile.registerExtension();
            Identity.registerExtension();
            Lifecycle.registerExtension();
            Signal.registerExtension();
            MobileCore.start(new AdobeCallback () {
            @Override
            public void call(Object o) {
            MobileCore.configureWithAppID("<your_environment_id_from_Launch>");
    }
});
    } catch (InvalidInitException e) {
      ...
    }
  }
}

{% endtab %}

{% tab title="iOS (AEP 3.x)" %}

{% hint style="info" %} For iOS Swift libraries, registration is changed to a single API call (as shown in the snippets below). Calling theMobileCore.start API is no longer required. {% endhint %}

Swift

// AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    MobileCore.registerExtensions([Signal.self, Lifecycle.self, UserProfile.self, Edge.self, AEPEdgeIdentity.Identity.self, Consent.self, AEPIdentity.Identity.self, Analytics.self], {
        MobileCore.configureWith(appId: "yourLaunchEnvironmentID")
    })
  ...
}

Objective-C

// AppDelegate.m
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileSignal.class, AEPMobileLifecycle.class, AEPMobileUserProfile.class, AEPMobileEdge.class, AEPMobileEdgeIdentity.class, AEPMobileEdgeConsent.class, AEPMobileIdentity.class, AEPMobileAnalytics.class] completion:^{
    [AEPMobileCore configureWithAppId: @"yourLaunchEnvironmentID"];
  }];
  ...
}

{% endtab %}

{% tab title="iOS (ACP 2.x)" %}

The following snippet shows an example of how to add the initialization code. Note that this may need to be adjusted, depending on how your application is structured.

Objective-C

#import "AppDelegate.h"
#import "ACPCore.h"
#import "ACPUserProfile.h"
#import "ACPIdentity.h"
#import "ACPLifecycle.h"
#import "ACPSignal.h"
...
@implementation AppDelegate
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [ACPCore setLogLevel:ACPMobileLogLevelDebug];
  [ACPCore configureWithAppId:@"<your_environment_id_from_Launch>"];
    ...
  [ACPUserProfile registerExtension];
    [ACPIdentity registerExtension];
    [ACPLifecycle registerExtension];
    [ACPSignal registerExtension];
    const UIApplicationState appState = application.applicationState;
    [ACPCore start:^{
      // only start lifecycle if the application is not in the background
      if (appState != UIApplicationStateBackground) {
        [ACPCore lifecycleStart:nil];
      }
    }];
    ...
  return YES;
}

@end

Swift

import ACPCore
import ACPUserProfile
...
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
  var window: UIWindow?
  func application(_application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool{
    ACPCore.setLogLevel(.debug)
        ACPCore.configure(withAppId: "<your_environment_id_from_Launch>")
    ...
    ACPUserProfile.registerExtension()
        ACPIdentity.registerExtension()
        ACPLifecycle.registerExtension()
        ACPSignal.registerExtension()
        ACPCore.start {
        ACPCore.lifecycleStart(nil)
        }
    ...
    return true
  }
}

{% endtab %}

{% tab title="React Native" %} For React Native apps, initialize the SDK using native code in your AppDelegate (iOS) and MainApplication (Android).

iOS

#import "ACPCore.h"
#import "ACPUserProfile.h"
#import "ACPIdentity.h"
#import "ACPLifecycle.h"
#import "ACPSignal.h"
...
@implementation AppDelegate
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCore setLogLevel:ACPMobileLogLevelDebug];
    [ACPCore configureWithAppId:@"<your_environment_id_from_Launch>"];
    [ACPUserProfile registerExtension];
    [ACPIdentity registerExtension];
    [ACPLifecycle registerExtension];
    [ACPSignal registerExtension];

    const UIApplicationState appState = application.applicationState;
    [ACPCore start:^{
      // only start lifecycle if the application is not in the background
      if (appState != UIApplicationStateBackground) {
        [ACPCore lifecycleStart:nil];
      }
    }];
    ...
  return YES;
}

@end

Android

import com.adobe.marketing.mobile.AdobeCallback;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.InvalidInitException;
import com.adobe.marketing.mobile.Lifecycle;
import com.adobe.marketing.mobile.LoggingMode;
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Signal;
import com.adobe.marketing.mobile.UserProfile;
...
import android.app.Application;
...
public class MainApplication extends Application implements ReactApplication {
  ...
  @Override
  public void on Create(){
    super.onCreate();
    ...
    MobileCore.setApplication(this);
    MobileCore.setLogLevel(LoggingMode.DEBUG);
    MobileCore.setWrapperType(WrapperType.REACT_NATIVE);

    try {
      UserProfile.registerExtension();
      Identity.registerExtension();
      Lifecycle.registerExtension();
      Signal.registerExtension();
      MobileCore.start(new AdobeCallback () {
          @Override
          public void call(Object o) {
            MobileCore.configureWithAppID("<your_environment_id_from_Launch>");
         }
      });
    } catch (InvalidInitException e) {
      ...
    }
  }
}

{% endtab %}

{% tab title="Flutter" %}

Dart

For Flutter apps, initialize the SDK using native code in your AppDelegate and MainApplication in iOS and Android, respectively.

The initialization code is located in the Flutter ACPCore Github README. {% endtab %}

{% tab title="Cordova" %} For Cordova apps, initialize the SDK using native code in your AppDelegate and MainApplication in iOS and Android, respectively.

iOS

// Import the SDK
#import "ACPCore.h"
#import "ACPLifecycle.h"
#import "ACPIdentity.h"
#import "ACPSignal.h"
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {  
  // make sure to set the wrapper type at the beginning of initialization
  [ACPCore setWrapperType:ACPMobileWrapperTypeCordova];

  //...
  [ACPCore configureWithAppId:@"yourAppId"];
  [ACPIdentity registerExtension];
  [ACPLifecycle registerExtension];
  [ACPSignal registerExtension];
  // Register any additional extensions

  [ACPCore start:nil];
}

Android

// Import the SDK
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.Lifecycle;
import com.adobe.marketing.mobile.Signal;
import com.adobe.marketing.mobile.WrapperType;

@Override
public void onCreate() {
  //...
  MobileCore.setApplication(this);
  MobileCore.configureWithAppID("yourAppId");

  // make sure to set the wrapper type at the beginning of initialization
  MobileCore.setWrapperType(WrapperType.CORDOVA);

  try {
    Identity.registerExtension();
    Lifecycle.registerExtension();
    Signal.registerExtension();

    // Register any additional extensions
  } catch (Exception e) {
    // handle exception
  }

  MobileCore.start(null);
}

{% endtab %}

{% tab title="Unity" %}

C#

For Unity apps, initialize the SDK using the following code in the start function of the MainScript.

using com.adobe.marketing.mobile;
using using AOT;

public class MainScript : MonoBehaviour
{
    [MonoPInvokeCallback(typeof(AdobeStartCallback))]
    public static void HandleStartAdobeCallback()
    {   
        ACPCore.ConfigureWithAppID("1423ae38-8385-8963-8693-28375403491d");
    }

    // Start is called before the first frame update
    void Start()
    {   
        if (Application.platform == RuntimePlatform.Android) {
            ACPCore.SetApplication();
        }

        ACPCore.SetLogLevel(ACPCore.ACPMobileLogLevel.VERBOSE);
        ACPCore.SetWrapperType();
        ACPIdentity.registerExtension();
        ACPLifecycle.registerExtension();
        ACPSignal.registerExtension();
        ACPCore.Start(HandleStartAdobeCallback);
    }
}

{% endtab %}

{% tab title="Xamarin" %}

C#

For Xamarin Forms applications, the SDK initialization differs, depending on the platform being targeted.

iOS

using Com.Adobe.Marketing.Mobile;

[Register("AppDelegate")]
public partial class AppDelegate : global::Xamarin.Forms.Platform.iOS.FormsApplicationDelegate
{
  //
  // This method is invoked when the application has loaded and is ready to run. In this
  // method you should instantiate the window, load the UI into it and then make the window
  // visible.
  //
  // You have 17 seconds to return from this method, or iOS will terminate your application.
  //
  public override bool FinishedLaunching(UIApplication app, NSDictionary options)
  {
    global::Xamarin.Forms.Forms.Init();
    LoadApplication(new App());

    // set the wrapper type
    ACPCore.SetWrapperType(ACPMobileWrapperType.Xamarin);

    // set launch config
    ACPCore.ConfigureWithAppID("your-app-id");

    // register SDK extensions
    ACPIdentity.RegisterExtension();
    ACPLifecycle.RegisterExtension();
    ACPSignal.RegisterExtension();

    // start core
    ACPCore.Start(null);
  }

Android

using Com.Adobe.Marketing.Mobile;

[Activity(Label = "TestApp", Icon = "@mipmap/icon", Theme = "@style/MainTheme", MainLauncher = true, ConfigurationChanges = ConfigChanges.ScreenSize | ConfigChanges.Orientation)]
public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity
{
  protected override void OnCreate(Bundle savedInstanceState)
  {
    base.OnCreate(savedInstanceState);

    global::Xamarin.Forms.Forms.Init(this, savedInstanceState);
    LoadApplication(new App());

    // set the wrapper type
    ACPCore.SetWrapperType(WrapperType.Xamarin);

    // register SDK extensions
    ACPCore.Application = this.Application;
    ACPIdentity.RegisterExtension();
    ACPLifecycle.RegisterExtension();
    ACPSignal.RegisterExtension();

    // start core
    ACPCore.Start(null);
}

{% endtab %} {% endtabs %}

registerURLHandler

Mobile SDK allows you to add a callback function that is triggered before the open url action occurs. If the callback function returns Yes, the SDK does not complete the open url action. If the callback function returns No, the SDK completes the open url action.

{% tabs %} {% tab title="iOS (ACP 2.x)" %} Objective C

Syntax

+ (void) registerURLHandler: (nonnull BOOL (^) (NSString* __nullable url)) callback;

Example

[ACPCore registerURLHandler:^BOOL(NSString * _Nullable url) {
    ...
}];

{% endtab %} {% endtabs %}

resetIdentities

The resetIdentities method requests that each extension resets the identities it owns and each extension responds to this request uniquely. For more details, check the resetIdentities API reference on each of the extensions you use.

{% tabs %} {% tab title="Android" %} Java

Note, this method is only available in Mobile Core v.1.8.0 and above.

Syntax

void resetIdentities();

Example

MobileCore.resetIdentities();

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

static func resetIdentities()

Example

MobileCore.resetIdentities()

Objective-C

Syntax

@objc(resetIdentities)
static func resetIdentities()

Example

[AEPMobileCore resetIdentities];

{% endtab %} {% endtabs %}

setAdvertisingIdentifier

The advertising ID is preserved between app upgrades, is saved and restored during the standard application backup process, available via Signals, and is removed at uninstall.

For more information about identity in Mobile Core, please read the documentation on the identity APIs.

setAppGroup (iOS only)

You can use the setAppGroup method to set the app group, which is used to share user defaults and files among the containing app and the extension apps.

{% hint style="info" %} This API must be called in AppDidFinishLaunching and before any other interactions with the Adobe Experience SDK have happened. Only the first call to this function will have any effect. {% endhint %}

{% tabs %} {% tab title="iOS (AEP 3.x)" %}

Swift

Syntax

public static func setAppGroup(_ group: String?)

Example

MobileCore.setAppGroup("appGroupId")

Objective-C

Syntax

@objc(setAppGroup:)
public static func setAppGroup(_ group: String?)

Example

[AEPMobileCore setAppGroup:@"app-group-id"];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

public static func setAppGroup(_ group: String?)

Example

[ACPCore setAppGroup:@"app-group-id"];

Swift

Syntax

public static func setAppGroup(_ group: String?)

Example

ACPCore.setAppGroup("app-group-id")

{% endtab %}

{% tab title="Xamarin" %} C#

Syntax

public static void SetAppGroup (string appGroup);

Example

ACPCore.SetAppGroup("app_group");

{% endtab %} {% endtabs %}

setApplication (Android only)

When building Android applications, the android.app.Application reference must be passed to Mobile SDK, which allows Mobile SDK to access the android.app.Context and monitor the lifecycle of the Android application.

{% hint style="warning" %} Android applications must call MobileCore.setApplication() before calling any other Mobile SDK API. {% endhint %}

You can use the setApplication method to pass the Android Application instance to Mobile SDK.

{% tabs %} {% tab title="Android" %} Java

Syntax

public static void setApplication(final Application app)

Example

public class CoreApp extends Application {

   @Override
   public void onCreate() {
      super.onCreate();
      MobileCore.setApplication(this);
      MobileCore.start(null);
   }
}

{% endtab %}

{% tab title="Xamarin" %} C#

Example

public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity
{
  protected override void OnCreate(Bundle savedInstanceState)
  {
    base.OnCreate(savedInstanceState);
    ACPCore.Application = this.Application;
    ACPCore.Start(null);
  }
}

{% endtab %} {% endtabs %}

setLogLevel

The logging APIs allow log messages to be tagged and filtered with the Mobile SDK log messages. This allows application developers to filter the logged messages based on the current logging mode.

Application developers can use the setLogLevel method to filter the log messages that are coming from the Mobile SDK.

From least to most verbose, the order of Mobile SDK logging modes is as follows:

  • ERROR
  • WARNING
  • DEBUG
  • VERBOSE / TRACE

When debugging on iOS, you can use LogLevel.verbose to enable all the logging messages that are coming from Mobile SDK and partner extensions. Similarly, on Android, you can use LoggingMode.VERBOSE to enable all the logging messages that are coming from Mobile SDK and partner extensions.

In a production application, you should use a less verbose logging mode, such as error-level logging.

By default, Mobile SDK logging mode is set to LoggingMode.ERROR for Android and LogLevel.erroron iOS.

{% hint style="info" %}

  • On Android, Mobile SDK uses the android.util.Log class to log messages.
  • On iOS, Mobile SDK uses NSLog to messages to Apple System Log facility. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

Syntax

public static void setLogLevel(LoggingMode mode)

Example

import com.adobe.marketing.mobile.LoggingMode;
import com.adobe.marketing.mobile.MobileCore;

MobileCore.setLogLevel(LoggingMode.VERBOSE);

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

 public static func setLogLevel(_ level: LogLevel)

Example

import AEPCore
import AEPServices

  MobileCore.setLogLevel(.trace)

Objective C

Syntax

 @objc(setLogLevel:)
 public static func setLogLevel(_ level: LogLevel)

Example

@import AEPCore;
@import AEPServices;

 [AEPMobileCore setLogLevel: AEPLogLevelTrace];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

(void) setLogLevel: (ACPMobileLogLevel) logLevel;

Example

#import "ACPCore.h"

[ACPCore setLogLevel: ACPMobileLogLevelVerbose];

Swift

Syntax

(void) setLogLevel: (ACPMobileLogLevel) logLevel;

Example

import ACPCore

ACPCore.setLogLevel(ACPMobileLogLevel.verbose);

{% endtab %}

{% tab title="React Native" %} Javascript

Syntax

(void) setLogLevel: (ACPMobileLogLevel) logLevel;

Example

import {ACPMobileLogLevel} from '@adobe/react-native-acpcore';
ACPCore.setLogLevel(ACPMobileLogLevel.VERBOSE);

{% endtab %}

{% tab title="Flutter" %} Dart

Syntax

(void) setLogLevel: (ACPMobileLogLevel) logLevel;

Example

import 'package:flutter_acpcore/src/acpmobile_logging_level.dart';
FlutterACPCore.setLogLevel(ACPLoggingLevel.VERBOSE);

{% endtab %}

{% tab title="Cordova" %} Cordova

From least to most verbose, the order of Mobile SDK logging modes is as follows:

  • ACPCore.ACPMobileLogLevelError
  • ACPCore.ACPMobileLogLevelWarning
  • ACPCore.ACPMobileLogLevelDebug
  • ACPCore.ACPMobileLogLevelVerbose

Syntax

ACPCore.setLogLevel = function(logLevel, success, fail);

Example

ACPCore.setLogLevel(ACPCore.ACPMobileLogLevelVerbose, successCallback, errorCallback);
 MobileCore.setSmallIconResourceID(R.mipmap.ic_launcher_round);

{% endtab %}

{% tab title="Unity" %} C#

From least to most verbose, the order of Mobile SDK logging modes is as follows:

  • ACPCore.ACPMobileLogLevel.ERROR
  • ACPCore.ACPMobileLogLevel.WARNING
  • ACPCore.ACPMobileLogLevel.DEBUG
  • ACPCore.ACPMobileLogLevel.VERBOSE

Syntax

public static void SetLogLevel(ACPMobileLogLevel logLevel)

Example

ACPCore.SetLogLevel(ACPCore.ACPMobileLogLevel.ERROR);

{% endtab %}

{% tab title="Xamarin" %} C#

From least to most verbose, the order of Mobile SDK logging modes is as follows for iOS:

  • ACPMobileLogLevel.Error;
  • ACPMobileLogLevel.Warning;
  • ACPMobileLogLevel.Debug;
  • ACPMobileLogLevel.Verbose;

From least to most verbose, the order of Mobile SDK logging modes is as follows for Android:

  • LoggingMode.Error;
  • LoggingMode.Warning;
  • LoggingMode.Debug;
  • LoggingMode.Verbose;

iOS syntax

public static ACPMobileLogLevel LogLevel { get, set }

Android syntax

public unsafe static LoggingMode LogLevel { get, set }

iOS example

ACPCore.LogLevel = ACPMobileLogLevel.Verbose;

Android example

ACPCore.LogLevel = LoggingMode.Verbose;

{% endtab %} {% endtabs %}

setPushIdentifier

This API sets the device token for push notifications in the SDK. If the current SDK privacy status is optedout, the push identifier is not set.

{% hint style="info" %} It is recommended to call setPushIdentifier on each application launch to ensure the most up-to-date device token is set to the SDK. If no device token is available, null/nil should be passed. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

Syntax

public static void setPushIdentifier(final String pushIdentifier);
  • pushIdentifier is a string that contains the device token for push notifications.

Example

//Retrieve the token from either GCM or FCM, and pass it to the SDK
MobileCore.setPushIdentifier(token);

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

public static func setPushIdentifier(_ deviceToken: Data?)

Example

MobileCore.setPushIdentifier(deviceToken)

Objective-C

Syntax

 @objc(setPushIdentifier:)
 public static func setPushIdentifier(_ deviceToken: Data?)

Example

 [AEPMobileCore setPushIdentifier:deviceToken];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

public static func setPushIdentifier(_ deviceToken: Data?)
  • deviceToken is a string that contains the device token for push notifications.

Example

// Set the deviceToken that the APNS has assigned to the device
[ACPCore setPushIdentifier:deviceToken];

Swift

Syntax

@objc(setPushIdentifier:)
public static func setPushIdentifier(_ deviceToken: Data?)
  • deviceToken is a string that contains the device token for push notifications.

Example

// Set the deviceToken that the APNs has assigned to the device
MobileCore.setPushIdentifier(deviceToken)

{% endtab %} {% endtabs %}

setSmallIconResourceID / setLargeIconResourceID (Android only)

You can set the small and large icons that will be used for notifications that are created by the SDK. The small icon appears in the status bar and is the secondary image that is displayed when the user sees the complete notification in the notification center. The large icon is the primary image that is displayed when the user sees the complete notification in the notification center.

{% hint style="warning" %} The following methods are only available in Android and Xamarin Android. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

setSmallIconResourceID

Syntax

public static void setSmallIconResourceID(int resourceID)

Example

 MobileCore.setSmallIconResourceID(R.mipmap.ic_launcher_round);

setLargeIconResourceID

Syntax

public static void setLargeIconResourceID(int resourceID)

Example

 MobileCore.setLargeIconResourceID(R.mipmap.ic_launcher_round);

{% endtab %}

{% tab title="Xamarin" %} C#

setSmallIconResourceID

Syntax

public unsafe static void SetSmallIconResourceID (int resourceID);

Example

ACPCore.SetSmallIconResourceID(Resource.Mipmap.icon_round);

setLargeIconResourceID

Syntax

public unsafe static void SetLargeIconResourceID (int resourceID);

Example

 ACPCore.SetLargeIconResourceID(Resource.Mipmap.icon_round);

{% endtab %} {% endtabs %}

trackAction

Actions are events that occur in your application. You can use the trackAction method to track and measure an action. Each action has one or more corresponding metrics that are incremented each time the event occurs. For example, you can use an action to track new subscriptions, every time an article is viewed, or every time a level is completed.

{% hint style="warning" %} You want to use the trackAction method when you want to track an occurring event. In addition to the action name, you can also send context data with each trackAction call. {% endhint %}

{% hint style="info" %} If you installed and configured the Adobe Analytics extension, this method sends an Adobe Analytics action tracking hit with the provided optional context data. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

Syntax

public static void trackAction(final String action, final Map<String, String> contextData)
  • action contains the name of the action to track.
  • contextData contains the context data to attach on the hit.

Example

Map<String, String> additionalContextData = new HashMap<String, String>();
additionalContextData.put("customKey", "value");
MobileCore.trackAction("loginClicked", additionalContextData);

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

 static func track(action: String?, data: [String: Any]?)
  • action contains the name of the action to track.
  • contextData contains the context data to attach on this hit.

Example

 MobileCore.track(action: "action name", data: ["key": "value"])

Objective-C

Syntax

 @objc(trackAction:data:)
 static func track(action: String?, data: [String: Any]?)
  • action contains the name of the action to track.
  • contextData contains the context data to attach on this hit.

Example

  [AEPMobileCore trackAction:@"action name" data:@{@"key":@"value"}];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

+ (void) trackAction: (nullable NSString*) action data: (nullable NSDictionary*) contextData;
  • action contains the name of the action to track.
  • contextData contains the context data to attach on the hit.

Example

 [ACPCore trackAction:@"action name" data:@{@"key":@"value"}];

Swift

Syntax

@objc(trackAction:data:)
static func track(action: String?, data: [String: Any]?)
  • action contains the name of the action to track.
  • contextData contains the context data to attach on the hit.

Example

ACPCore.track(action: "action name", data: ["key": "value"])

{% endtab %}

{% tab title="React Native" %} Javascript

Syntax

trackAction(action?: String, contextData?: { string: string });
  • action contains the name of the action to track.
  • contextData contains the context data to attach on the hit.

Example

ACPCore.trackAction("action name", {"key": "value"});

{% endtab %}

{% tab title="Flutter" %} Dart

Syntax

Future<void> trackAction (String action, {Map<String, String> contextData});
  • action contains the name of the action to track.
  • contextData contains the context data to attach on the hit.

Example

FlutterACPCore.trackAction("action name",  data: {"key": "value"});

{% endtab %}

{% tab title="Unity" %} C#

Syntax

public static void TrackAction(string name, Dictionary<string, string> contextDataDict)
    • name contains the name of the action to track.
  • contextDataDict contains the context data to attach on the hit.

Example

var contextData = new Dictionary<string, string>();
contextData.Add("key", "value");
ACPCore.TrackAction("action", contextData);

{% endtab %}

{% tab title="Cordova" %} Cordova

Syntax

ACPCore.trackAction = function(action, contextData, success, fail);
  • action contains the name of the action to track.
  • contextData contains the context data to attach on this hit.
  • success callback is invoked when trackAction executes successfully.
  • fail callback is invoked when trackAction fails.

Example

ACPCore.trackAction("cordovaAction", {"cordovaKey":"cordovaValue"}, successCallback, errorCallback);

{% endtab %}

{% tab title="Xamarin" %} C#

iOS Syntax

public static void TrackAction (string action, NSMutableDictionary<NSString, NSString> data);
  • action contains the name of the action to track.
  • data contains the context data to attach on the hit.

Android Syntax

public unsafe static void TrackAction (string action, IDictionary<string, string> contextData);
  • action contains the name of the action to track.
  • contextData contains the context data to attach on the hit.

Example

iOS

var data = new NSMutableDictionary<NSString, NSString>
{
  ["key"] = new NSString("value")
};
ACPCore.TrackAction("action", data);

Android

var data = new Dictionary<string, string>();
data.Add("key", "value");
ACPCore.TrackAction("action", data);

{% endtab %} {% endtabs %}

trackState

States represent screens or views in your application. The trackState method needs to be called every time a new state is displayed in your application. For example, this method should be called when a user navigates from the home page to the news feed. This method sends an Adobe Analytics state tracking hit with optional context data.

{% hint style="info" %} If you installed and configured the Adobe Analytics extension, the trackState method increments page views and an Adobe Analytics state tracking hit with the provided optional context data. {% endhint %}

{% tabs %} {% tab title="Android" %} Java

In Android, trackState is typically called every time a new Activity is loaded.

Syntax

public static void trackState(final String state, final Map<String, String> contextData)
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

Example

Map<String, String> additionalContextData = new HashMap<String, String>();        
additionalContextData.put("customKey", "value");
MobileCore.trackState("homePage", additionalContextData);

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Swift

Syntax

 static func track(state: String?, data: [String: Any]?)
  • state contains the name of the state to track.
  • contextData contains the context data to attach on this hit.

Example

 MobileCore.track(state: "state name", data: ["key": "value"])

Objective-C

Syntax

 @objc(trackState:data:)
 static func track(state: String?, data: [String: Any]?)
  • state contains the name of the state to track.
  • contextData contains the context data to attach on this hit.

Example

  [AEPMobileCore trackState:@"state name" data:@{@"key":@"value"}];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %} Objective-C

Syntax

(void) trackState: (nullable NSString*) state data: (nullable NSDictionary*) contextData;
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

Example

 [ACPCore trackState:@"state name" data:@{@"key":@"value"}];

Swift

Syntax

+ (void) trackState: (nullable NSString*) state data: (nullable NSDictionary*) contextData;
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

Example

ACPCore.trackState("state name", data: ["key": "value"])

{% endtab %}

{% tab title="React Native" %} Javascript

Syntax

trackState(state?: String, contextData?: { string: string });
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

Example

ACPCore.trackState("state name", {"key": "value"});

{% endtab %}

{% tab title="Flutter" %} Dart

Syntax

Future<void> trackState (String state, {Map<String, String> contextData});
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

Example

FlutterACPCore.trackState("state name",  data: {"key1: "value"})

{% endtab %}

{% tab title="Cordova" %} Cordova

Syntax

ACPCore.trackState = function(state, contextData, success, fail);
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.
  • success callback is invoked when trackState executes successfully.
  • fail callback is invoked when trackState fails.

Example

ACPCore.trackState("cordovaState", {"cordovaKey":"cordovaValue"}, successCallback, errorCallback);

{% endtab %}

{% tab title="Unity" %} C#

Syntax

public static void TrackState(string name, Dictionary<string, string> contextDataDict)
  • state contains the name of the state to track.
  • contextDataDict contains the context data to attach on the hit.

Example

var dict = new Dictionary<string, string>();
dict.Add("key", "value");
ACPCore.TrackState("state", dict);

{% endtab %}

{% tab title="Xamarin" %} C#

iOS syntax

public static void TrackState (string state, NSMutableDictionary<NSString, NSString> data);
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

Android syntax

public unsafe static void TrackState (string state, IDictionary<string, string> contextData);
  • state contains the name of the state to track.
  • contextData contains the context data to attach on the hit.

iOS example

var data = new NSMutableDictionary<NSString, NSString>
{
  ["key"] = new NSString("value")
};
ACPCore.TrackState("state", data);

Android example

var data = new Dictionary<string, string>();
data.Add("key", "value");
ACPCore.TrackState("state", data);

{% endtab %} {% endtabs %}

Public classes

{% tabs %} {% tab title="Android" %} Java

AdobeCallback

The AdobeCallback class provides the interface to receive results when the asynchronous APIs perform the requested action.

public interface AdobeCallback<T> {    
    void call(final T value);
}

AdobeCallbackWithError

The AdobeCallbackWithError class provides the interface to receive results or an error when the asynchronous APIs perform the requested action.

When using this class, if the request cannot be completed within the default timeout or an unexpected error occurs, the request is stopped and the fail method is called with the corresponding AdobeError.

public interface AdobeCallbackWithError<T> extends AdobeCallback<T> {
    void fail(final AdobeError error);
}

AdobeError

The AdobeError class shows the errors that can be passed to an AdobeCallbackWithError:

  • UNEXPECTED_ERROR - An unexpected error occurred.
  • CALLBACK_TIMEOUT - The timeout was met.
  • CALLBACK_NULL - The provided callback function is null.
  • EXTENSION_NOT_INITIALIZED - The extension is not initialized.

Example

MobileCore.getPrivacyStatus(new AdobeCallbackWithError<MobilePrivacyStatus>() {
  @Override
  public void fail(final AdobeError error) {
    if (error == AdobeError.UNEXPECTED_ERROR) {
      // handle unexpected error
    } else if (error == AdobeError.CALLBACK_TIMEOUT) {
      // handle timeout error
    } else if (error == AdobeError.CALLBACK_NULL) {
      // handle null callback error
    } else if (error == AdobeError.EXTENSION_NOT_INITIALIZED) {
      // handle extension not initialized error
    }
  }

  @Override
  public void call(final MobilePrivacyStatus value) {
    // use MobilePrivacyStatus value
  }
});

{% endtab %}

{% tab title="iOS (AEP 3.x)" %}

AEPError

The AEPError enum shows the errors that can be passed to a completion handler callback from any API which uses one:

  • case unexpected - An unexpected error occured.
  • case callbackTimeout - The timeout was met.
  • case callbackNil - The provided callback function is nil.
  • case none - There was no error, used when an error return type is required but there was no error.
  • case serverError - There was a server error.
  • case networkError - There was a network error.
  • case invalidRequest - There was an invalid request.
  • case invalidResponse - There was an invalid response.
  • case errorExtensionNotInitialized - The extension is not initialized.

Examples

Swift

MobileCore.getSdkIdentities { (content, error) in
    if let error = error, let aepError = error as? AEPError {
        switch aepError {
        case .unexpected:
          // Handle unexpected error
        case .callbackTimeout:
          // Handle callback timeout error
        case .callbackNil:
          // Handle callback being nil error
        case .none:
          // no error
        case .serverError:
          // handle server error
        case .networkError:
          // handle network error
        case .invalidRequest:
          // handle invalid request error
        case .invalidResponse:
          // handle invalid response error
        case .errorExtensionNotInitialized:
          // handle extension not initialized error
        @unknown default:
          // handle unknown error
        }
    }
    ...
}

Objective-C

[AEPMobileCore getSdkIdentities:^(NSString * _Nullable content, NSError * _Nullable error) {
    if (error) {
        if (error.code == AEPErrorUnexpected) {
          // Handle unexpected error
        } else if (error.code == AEPErrorCallbackTimeout) {
          // Handle callback timeout error
        } else if (error.code == AEPErrorCallbackNil) {
          // Handle callback being nil error
        } else if (error.code == AEPErrorNone) {
          // no error     
        } else if (error.code == AEPErrorServerError) {
          // handle server error
        } else if (error.code == AEPErrorNetworkError) {
          // handle network error 
        } else if (error.code == AEPErrorInvalidRequest) {
          // handle invalid request error
        } else if (error.code == AEPErrorInvalidResponse) {
          // handle invalid response error  
        } else if (error.code == AEPErrorErrorExtensionNotInitialized) {
          // handle extension not intialized error  
        }
    }

    ...
}];

{% endtab %}

{% tab title="iOS (ACP 2.x)" %}

ACPError

The ACPError class shows the errors that can be passed to a completion handler callback from any API which uses one:

  • ACPErrorUnexpected - An unexpected error occurred.
  • ACPErrorCallbackTimeout - The timeout was met.
  • ACPErrorCallbackNil - The provided callback function is nil.
  • ACPErrorExtensionNotInitialized - The extension is not initialized.

Examples

Objective-C

[ACPCore getSdkIdentities:^(NSString * _Nullable content, NSError * _Nullable error) {
  if (error) {
    if (error.code == ACPErrorCallbackTimeout) {
      // handle timeout error
    } else if (error.code == ACPErrorCallbackNil) {
      // handle nil callback error
    } else if (error.code == ACPErrorExtensionNotInitialized) {
      // handle extension not initialized error
    } else if (error.code == ACPErrorUnexpected) {
      // handle unexpected error

    ....

  } else {
    // use privacy status
  }
}];

Swift

ACPCore.getPrivacyStatus { (privacyStatus, error) in
  if let error = error {
    let callbackError: NSError = (error as NSError)
    if (callbackError.code == ACPError.callbackTimeout.rawValue) {
      // handle timeout error
    } else if (callbackError.code == ACPError.callbackNil.rawValue) {
      // handle nil callback error
    } else if (callbackError.code == ACPError.extensionNotInitialized.rawValue) {
      // handle extension not initialized error
    } else if (callbackError.code == ACPError.unexpected.rawValue) {
      // handle unexpected error
    }
  } else {
    // use privacyStatus
  }
}

{% endtab %}

{% tab title="Xamarin" %}

Android

IAdobeCallback

This class provides the interface to receive results when the async APIs perform the requested action.

public interface IAdobeCallback : IJavaObject, IDisposable, IJavaPeerable
{
    void Call (Java.Lang.Object p0);
}

IAdobeCallbackWithError

This class provides the interface to receive results or an error when the async APIs perform the requested action. When using this class, if the request cannot be completed within the default timeout or an unexpected error occurs, the request is aborted and the fail method is called with the corresponding AdobeError.

public interface IAdobeCallbackWithError : IAdobeCallback, IJavaObject, IDisposable, IJavaPeerable
{
    void Fail (AdobeError p0);
}

AdobeError

Errors which may be passed to an AdobeCallbackWithError:

  • UnexpectedError - An unexpected error occurred.
  • CallbackTimeout - The timeout was met.
  • CallbackNull - The provided callback function is null.
  • ExtensionNotInitialized - The extension is not initialized.

Example

ACPCore.GetPrivacyStatus(new AdobeCallbackWithError());
class AdobeCallbackWithError : Java.Lang.Object, IAdobeCallbackWithError
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("String callback content: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
  public void Fail(AdobeError error)
  {
    if (error == AdobeError.UnexpectedError)
    {
      // handle unexpected error
    }
    else if (error == AdobeError.CallbackTimeout)
    {
      // handle timeout error
    }
    else if (error == AdobeError.CallbackNull)
    {
      // handle null callback error
    }
    else if (error == AdobeError.ExtensionNotInitialized)
    {
        // handle extension not initialized error
    }

iOS

ACPError

Errors which may be passed to a completion handler callback from any API which uses one:

  • ACPError.Unexpected - An unexpected error occurred.
  • ACPError.CallbackTimeout - The timeout was met.
  • ACPError.CallbackNil - The provided callback function is nil.
  • ACPError.ExtensionNotInitialized - The extension is not initialized.

Example

ACPCore.GetPrivacyStatusWithCompletionHandler((privacyStatus, error) => {
  if (error != null)
  {
    if ( error.Code == (int)ACPError.CallbackTimeout)
    {
      // handle timeout error
    }
    else if (error.Code == (int)ACPError.CallbackNil) 
    {
      // handle nil callback error
    }
    else if (error.Code == (int)ACPError.ExtensionNotInitialized)
    {
      // handle extension not initialized error
    }
    else if (error.Code == (int)ACPError.Unexpected)
    {
      // handle unexpected error
    }
  }
  else
  {
    Console.WriteLine("privacy status: " + privacyStatus);
  }
});

{% endtab %} {% endtabs %}

Additional information

To learn what context data is, please read the documentation on context data.