Campaign Classic API reference

extensionVersion

The extensionVersion API returns the version of the Campaign Classic extension that is registered with the Mobile Core extension.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)

Java

Syntax
public static String extensionVersion();
Example
String campaignClassicExtensionVersion = CampaignClassic.extensionVersion();

Swift

Syntax
static var extensionVersion: String
Example
let campaignClassicVersion = CampaignClassic.extensionVersion

Objective-C

Syntax
+ (nonnull NSString *)extensionVersion
Example
NSString *campaignClassicVersion = [AEPMobileCampaignClassic extensionVersion];

Swift

Syntax
static func extensionVersion() -> String
Example
let campaignClassicExtensionVersion = ACPCampaignClassic.extensionVersion()

Objective-C

Syntax
+(NSString) extensionVersion;
Example
NSString *campaignClassicExtensionVersion = [ACPCampaignClassic extensionVersion];

registerDevice

The registerDevice API lets you register a user device with Campaign Classic.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
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. A boolean value is returned in the callback, which signals whether the registration was successful.

Java

Syntax
public static void registerDevice(final String token, final String userKey, final Map<String, Object> additionalParams, final AdobeCallback<Boolean> callback)
Example
@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, "[email protected]", additionalParams,new AdobeCallback<Boolean>() {
@Override
public void call(final Boolean status) {
Log.d("TestApp", "Registration Status: " + status);
}
});
}
}
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
static func registerDevice(token: Data, userKey: String?, additionalParameters: [String: Any]?)
Example
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
let params: [String: Any] = [
"name": "John",
"serial": 12345,
"premium": true
]
CampaignClassic.registerDevice(token: deviceToken, userKey: "[email protected]", additionalParameters: params)
}

Objective-C

Syntax
+ (void) registerDeviceWithToken:(nonnull NSData*)token userKey:(nullable NSString*)userKey additionalParams:(nullable NSDictionary<NSString *, id> *)additionalParams;
Example
- (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:@"[email protected]" additionalParameters:params];
}
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. A boolean value is returned in the callback, which signals whether the registration was successful.

Swift

Syntax
static func registerDevice(_ token: Data, userKey: String?, additionalParams: [String: Any]?, callback: ((Bool) -> Void)?)
Example
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
let params: [String: Any] = [
"name": "John",
"serial": 12345,
"premium": true
]
ACPCampaignClassic.registerDevice(deviceToken, userKey: "[email protected]", additionalParams: params) {
result in
print("Registration status: \(result)")
}
}

Objective-C

Syntax
+ (void) registerDevice: (nonnull NSData*) token userKey: (nullable NSString*) userKey additionalParams: (nullable NSDictionary*) additionalParams callback: (nullable void (^) (BOOL success)) callback;
Example
- (void) application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
// Set the deviceToken that the APNS has assigned to the device
NSMutableDictionary *params = [[NSMutableDictionary alloc] initWithObjectsAndKeys: @"John", @"name", nil];
[params setObject: [NSNumber numberWithInt:12345] forKey: @"serial"];
[params setObject: [NSNumber numberWithBool:YES] forKey: @"premium"];
[ACPCampaignClassic registerDevice:deviceToken userKey:@"[email protected]" additionalParams:params callback:^(BOOL success) {
NSLog(@"Registration Status: %d", success);
}];

trackNotificationClick

The trackNotificationClick API sends the clicked push notification's tracking information to the configured Adobe Campaign Classic server. This API can be used to send tracking information when the notification is clicked, which may result in the application being opened.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)

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
public static void trackNotificationClick(final Map<String, String> trackInfo)
Example
@Override
public void onResume() {
super.onResume();
// Perform any other app related tasks
// 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
static func trackNotificationClick(withUserInfo userInfo: [AnyHashable: Any])
Example
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
CampaignClassic.trackNotificationClick(withUserInfo: response.notification.request.content.userInfo)
}

Objective-C

Syntax
+ (void) trackNotificationClickWithUserInfo: (nonnull NSDictionary*) userInfo;
Example
-(void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler{
NSDictionary *userInfo = response.notification.request.content.userInfo;
[AEPMobileCampaignClassic trackNotificationClickWithUserInfo:userInfo];
completionHandler();
}
You can pass the launchOptions that were received upon opening the application or userInfo, which contains the received push payload in trackInfo. If trackInfo is null or does not contain the necessary tracking identifiers, broadlogId (_mId) and deliveryId (_dId), a track request is not sent.

Swift

Syntax
static func trackNotificationClick(_ trackInfo: [String: String])
Example
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
guard let userInfo = response.notification.request.content.userInfo as? [String: String] else {
return;
}
ACPCampaignClassic.trackNotificationClick(userInfo);
completionHandler();
}

Objective-C

Syntax
+ (void) trackNotificationClick: (nonnull NSDictionary<NSString*, NSString*>*) trackInfo;
Example
-(void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler
{
NSLog(@"User Info : %@",response.notification.request.content.userInfo);
// Track action selected by the user for a given notification
[ACPCampaignClassic trackNotificationClick:response.notification.request.content.userInfo];
completionHandler();
}

trackNotificationReceive

The trackNotificationReceive API sends the received push notification's tracking information to the configured Adobe Campaign Classic server.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)

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
public static void trackNotificationReceive(final Map<String, String> trackInfo)
Example
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
static func trackNotificationReceive(withUserInfo userInfo: [AnyHashable: Any])
Example
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
+ (void) trackNotificationReceiveWithUserInfo:(nonnull NSDictionary*) userInfo;
Example
- (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);
}
}
You can pass the launchOptions that were received upon opening the application or userInfo , which contains the received push payload in trackInfo. If trackInfo is null or does not contain the necessary tracking identifiers, broadlogId (_mId) and deliveryId (_dId), a track request is not sent.

Swift

Syntax
static func trackNotificationReceive(_ trackInfo: [String: String])
Example
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
ACPCampaignClassic.trackNotificationReceive(userInfo)
completionHandler(.noData)
}
}

Objective-C

Syntax
+ (void) trackNotificationReceive: (nonnull NSDictionary<NSString*, NSString*>*) trackInfo;
Example
- (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");
[ACPCampaignClassic trackNotificationReceive:launchOptions];
completionHandler(UIBackgroundFetchResultNoData);
}
}
Export as PDF
Copy link
Edit on GitHub
On this page
extensionVersion
registerDevice
trackNotificationClick
trackNotificationReceive