Adobe Campaign Classic API reference

Java

Syntax

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

Example

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

Swift

Syntax

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

Example

Copy
let campaignClassicVersion = CampaignClassic.extensionVersion
Copied to your clipboard
let campaignClassicVersion = CampaignClassic.extensionVersion

Objective-C

Syntax

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

Example

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

To prepare your app to handle push notifications, see the tutorial on setting up a Firebase Cloud Messaging client app on Android. After you receive the Firebase Cloud Messaging (FCM) SDK registration token, send this token and the device information to Campaign Classic by using the registerDevice API.

The registerDevice API registers a device with your Campaign Classic registration server. It takes the FCM registration token as a parameter with a user key that identifies a user, such as an email address or a login name. You can also provide a map of the custom key-value pairs that you want to associate with the registration.

Java

Syntax

Copy
public static void registerDevice(@NonNull final String token, final String userKey, final Map<String, Object> additionalParams)
Copied to your clipboard
public static void registerDevice(@NonNull final String token, final String userKey, final Map<String, Object> additionalParams)

Example

Copy
@Override
public void onNewToken(String token) {
    Log.d("TestApp", "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this app's subscriptions on the server side, send the
    // Instance ID token to your app server.
    if (token != null) {
        Log.d("TestApp", "FCM SDK registration token received : " + token);
        
        // Create a map of additional parameters
        Map<String, Object> additionalParams = new HashMap<String, Object>();
        additionalParams.put("name", "John");
        additionalParams.put("serial", 12345);
        additionalParams.put("premium", true);
    
        // Send the registration info
        CampaignClassic.registerDevice(token, "john@example.com", additionalParams);
    }
}
Copied to your clipboard
@Override
public void onNewToken(String token) {
    Log.d("TestApp", "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this app's subscriptions on the server side, send the
    // Instance ID token to your app server.
    if (token != null) {
        Log.d("TestApp", "FCM SDK registration token received : " + token);
        
        // Create a map of additional parameters
        Map<String, Object> additionalParams = new HashMap<String, Object>();
        additionalParams.put("name", "John");
        additionalParams.put("serial", 12345);
        additionalParams.put("premium", true);
    
        // Send the registration info
        CampaignClassic.registerDevice(token, "john@example.com", additionalParams);
    }
}

To get your app ready to handle push notifications, see the tutorial on configuring remote notification support. After you receive the Apple Push Notification service (APNs) token, send this token and the device information to Campaign Classic using the registerDevice API.

The registerDevice API registers a device with your Campaign Classic registration server. It takes the APNS token as a parameter with a user key that identifies a user, such as an email address or a login name. You can also provide a map of the custom key-value pairs that you want to associate with the registration.

Swift

Syntax

Copy
static func registerDevice(token: Data, userKey: String?, additionalParameters: [String: Any]?)
Copied to your clipboard
static func registerDevice(token: Data, userKey: String?, additionalParameters: [String: Any]?)

Example

Copy
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    let params: [String: Any] = [
        "name": "John",
        "serial": 12345,
        "premium": true
    ]

    CampaignClassic.registerDevice(token: deviceToken, userKey: "johnDoe@example.com", additionalParameters: params)
}
Copied to your clipboard
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    let params: [String: Any] = [
        "name": "John",
        "serial": 12345,
        "premium": true
    ]

    CampaignClassic.registerDevice(token: deviceToken, userKey: "johnDoe@example.com", additionalParameters: params)
}

Objective-C

Syntax

Copy
+ (void) registerDeviceWithToken:(nonnull NSData*)token userKey:(nullable NSString*)userKey additionalParams:(nullable NSDictionary<NSString *, id> *)additionalParams;
Copied to your clipboard
+ (void) registerDeviceWithToken:(nonnull NSData*)token userKey:(nullable NSString*)userKey additionalParams:(nullable NSDictionary<NSString *, id> *)additionalParams;

Example

Copy
- (void) application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    NSMutableDictionary *params = [[NSMutableDictionary alloc] initWithObjectsAndKeys:  @"John", @"name", nil];
    [params setObject: [NSNumber numberWithInt:12345] forKey: @"serial"];
    [params setObject: [NSNumber numberWithBool:YES]  forKey: @"premium"];

    [AEPMobileCampaignClassic registerDeviceWithToken:deviceToken userKey:@"john@example.com" additionalParameters:params];
}
Copied to your clipboard
- (void) application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    NSMutableDictionary *params = [[NSMutableDictionary alloc] initWithObjectsAndKeys:  @"John", @"name", nil];
    [params setObject: [NSNumber numberWithInt:12345] forKey: @"serial"];
    [params setObject: [NSNumber numberWithBool:YES]  forKey: @"premium"];

    [AEPMobileCampaignClassic registerDeviceWithToken:deviceToken userKey:@"john@example.com" additionalParameters:params];
}

Java

Syntax

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

Example

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

Java

If trackInfo is null or does not contain the necessary tracking identifiers, messageId (_mId) and deliveryId (_dId), a track request is not sent.

Syntax

Copy
public static void trackNotificationReceive(@NonNull final Map<String, String> trackInfo)
Copied to your clipboard
public static void trackNotificationReceive(@NonNull final Map<String, String> trackInfo)

Example

Copy
public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        Log.d("TestApp", "Receive message from: " + remoteMessage.getFrom());
        Map<String,String> payloadData = message.getData();

        // Check if message contains data payload.
        if (payloadData.size() > 0) {
            Map<String,String> trackInfo = new HashMap<>();
            trackInfo.put("_mId", payloadData.get("_mId"));
            trackInfo.put("_dId", payloadData.get("_dId"));

            // Send the tracking information for message received
            CampaignClassic.trackNotificationReceive(trackInfo);
        }
    }
}
Copied to your clipboard
public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        Log.d("TestApp", "Receive message from: " + remoteMessage.getFrom());
        Map<String,String> payloadData = message.getData();

        // Check if message contains data payload.
        if (payloadData.size() > 0) {
            Map<String,String> trackInfo = new HashMap<>();
            trackInfo.put("_mId", payloadData.get("_mId"));
            trackInfo.put("_dId", payloadData.get("_dId"));

            // Send the tracking information for message received
            CampaignClassic.trackNotificationReceive(trackInfo);
        }
    }
}

You can pass the launchOptions that were received upon opening the application or userInfo, which contains the received push payload in userInfo. If userInfo is null or does not contain the necessary tracking identifiers, broadlogId (_mId) and deliveryId (_dId), a track request is not sent.

Swift

Syntax

Copy
static func trackNotificationReceive(withUserInfo userInfo: [AnyHashable: Any])
Copied to your clipboard
static func trackNotificationReceive(withUserInfo userInfo: [AnyHashable: Any])

Example

Copy
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    guard let aps = userInfo["aps"] as? [String: Any] else {
        completionHandler(.failed)
        return
    }
    if aps["content-available"] as? Int == 1 {
        // Track silent push notification receive
        CampaignClassic.trackNotificationReceive(withUserInfo: userInfo)
        completionHandler(.noData)
    }
}
Copied to your clipboard
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    guard let aps = userInfo["aps"] as? [String: Any] else {
        completionHandler(.failed)
        return
    }
    if aps["content-available"] as? Int == 1 {
        // Track silent push notification receive
        CampaignClassic.trackNotificationReceive(withUserInfo: userInfo)
        completionHandler(.noData)
    }
}

Objective-C

Syntax

Copy
+ (void) trackNotificationReceiveWithUserInfo:(nonnull NSDictionary*) userInfo;
Copied to your clipboard
+ (void) trackNotificationReceiveWithUserInfo:(nonnull NSDictionary*) userInfo;

Example

Copy
- (void) application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)launchOptions fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
{
    if ( launchOptions) NSLog(@"launchOptions: %@", [launchOptions description]);
    // Tracking silent push notification receive
    if ( [launchOptions[@"aps"][@"content-available"] intValue] == 1 ) {
        NSLog(@"Silent Push Notification");
        [AEPMobileCampaignClassic trackNotificationReceiveWithUserInfo:userInfo];
        completionHandler(UIBackgroundFetchResultNoData);
    }
}
Copied to your clipboard
- (void) application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)launchOptions fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
{
    if ( launchOptions) NSLog(@"launchOptions: %@", [launchOptions description]);
    // Tracking silent push notification receive
    if ( [launchOptions[@"aps"][@"content-available"] intValue] == 1 ) {
        NSLog(@"Silent Push Notification");
        [AEPMobileCampaignClassic trackNotificationReceiveWithUserInfo:userInfo];
        completionHandler(UIBackgroundFetchResultNoData);
    }
}

Java

If trackInfo is null, or does not contain the necessary tracking identifiers, messageId (_mId) and deliveryId (_dId), a track request is not sent.

Syntax

Copy
public static void trackNotificationClick(@NonNull final Map<String, String> trackInfo)
Copied to your clipboard
public static void trackNotificationClick(@NonNull final Map<String, String> trackInfo)

Example

Copy
@Override
public void onResume() {
    super.onResume();
    
    // The messageId (_mId) and deliveryId (_dId) can be passed in the intent extras.
    // This is assuming you extract the messageId and deliveryId from the
    // received push message and are including it in the intent (intent.putExtra())
    // of the displayed notification.

    Bundle extras = getIntent().getExtras();
    if (extras != null) {
        String deliveryId = extras.getString("_dId");
        String messageId = extras.getString("_mId");
        if (deliveryId != null && messageId != null) {
            Map<String,String> trackInfo = new HashMap<>();
            trackInfo.put("_mId", messageId);
            trackInfo.put("_dId", deliveryId);

            // Send the tracking information for message opening
            CampaignClassic.trackNotificationClick(trackInfo);
        }
    }
}
Copied to your clipboard
@Override
public void onResume() {
    super.onResume();
    
    // The messageId (_mId) and deliveryId (_dId) can be passed in the intent extras.
    // This is assuming you extract the messageId and deliveryId from the
    // received push message and are including it in the intent (intent.putExtra())
    // of the displayed notification.

    Bundle extras = getIntent().getExtras();
    if (extras != null) {
        String deliveryId = extras.getString("_dId");
        String messageId = extras.getString("_mId");
        if (deliveryId != null && messageId != null) {
            Map<String,String> trackInfo = new HashMap<>();
            trackInfo.put("_mId", messageId);
            trackInfo.put("_dId", deliveryId);

            // Send the tracking information for message opening
            CampaignClassic.trackNotificationClick(trackInfo);
        }
    }
}

You can pass the launchOptions that were received upon opening the application or userInfo, which contains the received push payload in userInfo. If userInfo is null or does not contain the necessary tracking identifiers, broadlogId (_mId) and deliveryId (_dId), a track request is not sent.

Swift

Syntax

Copy
static func trackNotificationClick(withUserInfo userInfo: [AnyHashable: Any])
Copied to your clipboard
static func trackNotificationClick(withUserInfo userInfo: [AnyHashable: Any])

Example

Copy
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
    CampaignClassic.trackNotificationClick(withUserInfo: response.notification.request.content.userInfo)
}
Copied to your clipboard
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
    CampaignClassic.trackNotificationClick(withUserInfo: response.notification.request.content.userInfo)
}

Objective-C

Syntax

Copy
+ (void) trackNotificationClickWithUserInfo: (nonnull NSDictionary*) userInfo;
Copied to your clipboard
+ (void) trackNotificationClickWithUserInfo: (nonnull NSDictionary*) userInfo;

Example

Copy
- (void) userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler{
    NSDictionary *userInfo = response.notification.request.content.userInfo;
    [AEPMobileCampaignClassic trackNotificationClickWithUserInfo:userInfo];
    completionHandler();
}
Copied to your clipboard
- (void) userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler{
    NSDictionary *userInfo = response.notification.request.content.userInfo;
    [AEPMobileCampaignClassic trackNotificationClickWithUserInfo:userInfo];
    completionHandler();
}

Requires extension version v2.1.0 through the next major version release

Builds an AEPPushPayload with data extracted from a RemoteMessage's payload. The built AEPPushPayload is then used to construct a Notification.

Java

Syntax

Copy
@NonNull 
public static boolean handleRemoteMessage(@NonNull final Context context, @NonNull final RemoteMessage remoteMessage);
Copied to your clipboard
@NonNull 
public static boolean handleRemoteMessage(@NonNull final Context context, @NonNull final RemoteMessage remoteMessage);

Example

Copy
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    Log.d(LOG_TAG, "From: " + remoteMessage.getFrom());
        if (AEPMessagingService.handleRemoteMessage(this, remoteMessage)) {
            // Campaign extension has handled the notification
        } else {
            // Handle notification from other sources
        }
}
Copied to your clipboard
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    Log.d(LOG_TAG, "From: " + remoteMessage.getFrom());
        if (AEPMessagingService.handleRemoteMessage(this, remoteMessage)) {
            // Campaign extension has handled the notification
        } else {
            // Handle notification from other sources
        }
}