Application reference (Android Only)

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

Set Application

You can use this API to pass the Android Application instance to the SDK.

public static void setApplication(final Application app)

public class CoreApp extends Application {
​
   @Override
   public void onCreate() {
      super.onCreate();
      MobileCore.setApplication(this);
      MobileCore.start(null);
   }
}

Get Application

You can use this API to get the previously set Android Application instance, and this instance is mainly provided for the third-party extensions.

public static Application getApplication()

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

Track app actions

Actions are events that occur in your app. You can use this API 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 might call this API for each new subscription each time an article is viewed, or each time a level is completed.

public static void trackAction(final String action, final Map<String, String> contextData)

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

+ (void) trackAction: (nullable NSString*) action data: (nullable NSDictionary*) data;

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

+ (void) trackAction: (nullable NSString*) action data: (nullable NSDictionary*) data;

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

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

Track app states and views

States represent screens or views in your app. Each time a new state is displayed in your application, for example, when a user navigates from the home page to the news feed, this API can be called. This method sends an Analytics state tracking hit with optional context data.

public static void trackState(final String state, final Map<String, String> contextData)

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

+ (void) trackState: (nullable NSString*) state data: (nullable NSDictionary*) data;

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

+ (void) trackState: (nullable NSString*) state data: (nullable NSDictionary*) data;

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

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

Collect PII

This API allows the SDK to collect sensitive or personally identifiable information (PII) data.

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

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

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

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

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

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

Collect launch information

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

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

 [ACPCore collectLaunchInfo:launchOptions];

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

ACPCore.collectLaunchInfo(userInfo)

Set Icons for local notification (Android Only)

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.

public static void setSmallIconResourceID(int resourceID)

 MobileCore.setSmallIconResourceID(R.mipmap.ic_launcher_round);

public static void setLargeIconResourceID(int resourceID)

 MobileCore.setLargeIconResourceID(R.mipmap.ic_launcher_round);

Logging

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

Application developers can use the setLogLevel API to filter the log messages that are coming from the Mobile SDK. When debugging, use LoggingMode.VERBOSE (Android) / ACPMobileLogLevelVerbose (iOS) to enable all the logging messages coming from the Mobile SDK and partner extensions. In a production application, we recommend that you use a less verbose logging mode, for example LoggingMode.ERROR (Android) / ACPMobileLogLevelError (iOS).

By default, the Mobile SDK logging mode is set to LoggingMode.ERROR (Android) / ACPMobileLogLevelError (iOS).

As a Mobile SDK extension developer, use the MobileCore (Android) / ACPCore (iOS) log API to include extension log messages with Mobile SDK core log messages.

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

• ERROR

• WARNING

• DEBUG

• VERBOSE

public static void setLogLevel(LoggingMode mode)

import com.adobe.marketing.mobile.LoggingMode;
import com.adobe.marketing.mobile.MobileCore;
...
​
MobileCore.setLogLevel(LoggingMode.VERBOSE);

+ (void) setLogLevel: (ACPMobileLogLevel) logLevel;

#import "ACPCore.h"
...
​
[ACPCore setLogLevel: ACPMobileLogLevelVerbose];

+ (void) setLogLevel: (ACPMobileLogLevel) logLevel;

import ACPCore
...
​
ACPCore.setLogLevel(ACPMobileLogLevel.verbose);

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

public static LoggingMode getLogLevel()

LoggingMode mode = MobileCore.getLogLevel();

+ (ACPMobileLogLevel) logLevel;

var logLevel:ACPMobileLogLevel = [ACPCore logLevel];

+ (ACPMobileLogLevel) logLevel;

let logLevel:ACPMobileLogLevel = ACPCore.logLevel();

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

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

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

D/AdobeExperienceSDK: MyClassName - Provided data was null

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

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

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

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

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

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

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

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

Handle open URL action

The Mobile SDK allows users to add a callback function that is triggered before the open url action occurrs. 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.

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

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

Additional Information

• What is context data?