Migrating to AEPCampaignClassic reference
This document is a reference comparison of AEPCampaignClassic (3.x) APIs against their equivalent APIs in ACPCampaignClassic (2.x) for an iOS mobile application implementation.
The AEPCampaignClassic extension is implemented purely in Swift and is compatible with the AEPCore Swift SDK. To ensure a smooth transition from the ACPCampaignClassic SDK, there are no major changes on the API names or definition. For more details, follow the migration guide below for your Swift or Objective-C mobile application. If explanation beyond showing API differences is necessary, it will be captured as a note within that API's section.
AEPCampaignClassic classes
| Type | AEP (3.x) | AEP 3.x (Objective-C) | ACP (2.x) |
|---|---|---|---|
Primary Class (Module) | CampaignClassic | AEPMobileCampaignClassic | ACPCampaignClassic |
AEPCampaignClassic APIs
extensionVersion
Copied to your clipboardstatic var extensionVersion: String
Copied to your clipboard+ (nonnull NSString*) extensionVersion;
Copied to your clipboard+ (nonnull NSString*) extensionVersion;
Copied to your clipboardstatic var extensionVersion: String
Copied to your clipboard+ (nonnull NSString*) extensionVersion;
Copied to your clipboard+ (nonnull NSString*) extensionVersion;
registerExtension
Registration occurs by passing CampaignClassic to the MobileCore.registerExtensions API.
Copied to your clipboardMobileCore.registerExtensions([CampaignClassic.self])
Registration occurs by passing AEPMobileCampaignClassic to the [AEPMobileCore registerExtensions:completion:] API.
Copied to your clipboard[AEPMobileCore registerExtensions:@[AEPMobileCampaignClassic.class] completion:nil];
Copied to your clipboard[ACPCampaignClassic registerExtension];[ACPCore start:^{}];
Registration occurs by passing CampaignClassic to the MobileCore.registerExtensions API.
Copied to your clipboardMobileCore.registerExtensions([CampaignClassic.self])
Registration occurs by passing AEPMobileCampaignClassic to the [AEPMobileCore registerExtensions:completion:] API.
Copied to your clipboard[AEPMobileCore registerExtensions:@[AEPMobileCampaignClassic.class] completion:nil];
Copied to your clipboard[ACPCampaignClassic registerExtension];[ACPCore start:^{}];
registerDevice
Copied to your clipboardstatic func registerDevice(token: Data, userKey: String?, additionalParameters: [String: Any]?)
Copied to your clipboard+ (void) registerDeviceWithToken: (nonnull NSData*) token userKey: (nullable NSString*) userKey additionalParams: (nullable NSDictionary*) additionalParams;
Copied to your clipboard+ (void) registerDevice: (nonnull NSData*) token userKey: (nullable NSString*) userKey additionalParams: (nullable NSDictionary*) additionalParams callback: (nullable void (^) (BOOL success)) callback;
Copied to your clipboardstatic func registerDevice(token: Data, userKey: String?, additionalParameters: [String: Any]?)
Copied to your clipboard+ (void) registerDeviceWithToken: (nonnull NSData*) token userKey: (nullable NSString*) userKey additionalParams: (nullable NSDictionary*) additionalParams;
Copied to your clipboard+ (void) registerDevice: (nonnull NSData*) token userKey: (nullable NSString*) userKey additionalParams: (nullable NSDictionary*) additionalParams callback: (nullable void (^) (BOOL success)) callback;
trackNotificationClick
Copied to your clipboardstatic func trackNotificationClick(withUserInfo userInfo: [AnyHashable: Any])
Copied to your clipboard+ (void) trackNotificationClickWithUserInfo:(nonnull NSDictionary*) userInfo;
Copied to your clipboard+ (void) trackNotificationClick:(nonnull NSDictionary<NSString*, NSString*>*) trackInfo;
Copied to your clipboardstatic func trackNotificationClick(withUserInfo userInfo: [AnyHashable: Any])
Copied to your clipboard+ (void) trackNotificationClickWithUserInfo:(nonnull NSDictionary*) userInfo;
Copied to your clipboard+ (void) trackNotificationClick:(nonnull NSDictionary<NSString*, NSString*>*) trackInfo;
trackNotificationReceive
Copied to your clipboardstatic func trackNotificationReceive(withUserInfo userInfo: [AnyHashable: Any])
Copied to your clipboard+ (void) trackNotificationReceiveWithUserInfo:(nonnull NSDictionary*) userInfo;
Copied to your clipboard+ (void) trackNotificationReceive:(nonnull NSDictionary<NSString*, NSString*>*) trackInfo;
Copied to your clipboardstatic func trackNotificationReceive(withUserInfo userInfo: [AnyHashable: Any])
Copied to your clipboard+ (void) trackNotificationReceiveWithUserInfo:(nonnull NSDictionary*) userInfo;
Copied to your clipboard+ (void) trackNotificationReceive:(nonnull NSDictionary<NSString*, NSString*>*) trackInfo;