Migrating to AEPCampaign reference

This document is a reference comparison of ACPCampaign (1.x) APIs against their equivalent APIs in AEPCampaign (3.x) for an iOS mobile application implementation.

The AEPCampaign extension is implemented purely in Swift and is compatible with the AEPCore swift SDK. To ensure a smooth transition from the ACPCampaign 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 an info hint within that API's section.

AEPCampaign classes

Type

AEP (3.x)

AEP 3.x (Objective-C)

ACP (1.x)

Primary Class (Module)

Campaign

AEPMobileCampaign

ACPCampaign

AEPCampaign APIs

extensionVersion

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 1.x (Objective-C)
AEP 3.x (Swift)
static var extensionVersion: String
AEP 3.x (Objective-C)
+ (nonnull NSString*) extensionVersion;
ACP 1.x (Objective-C)
+ (nonnull NSString*) extensionVersion;

registerExtension

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 1.x (Objective-C)
AEP 3.x (Swift)

Registration occurs by passing Campaign to the MobileCore.registerExtensions API.

MobileCore.registerExtensions([Campaign.self])
AEP 3.x (Objective-C)

Registration occurs by passing AEPMobileCampaign to the [AEPMobileCore registerExtensions:completion:] API.

[AEPMobileCore registerExtensions:@[AEPMobileCampaign.class] completion:nil];
ACP 1.x (Objective-C)
+ (void) registerExtension;

resetLinkageFields

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 1.x (Objective-C)
AEP 3.x (Swift)
static func resetLinkageFields()
AEP 3.x (Objective-C)
+ (void) resetLinkageFields;
ACP 1.x (Objective-C)
+ (void) resetLinkageFields;

setLinkageFields

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 1.x (Objective-C)
AEP 3.x (Swift)
static func setLinkageFields(linkageFields: [String: String])
AEP 3.x (Objective-C)
+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*)
ACP 1.x (Objective-C)
+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields;