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
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 Campaign
to the MobileCore.registerExtensions
API.
Copied to your clipboardMobileCore.registerExtensions([Campaign.self])
Registration occurs by passing AEPMobileCampaign
to the [AEPMobileCore registerExtensions:completion:]
API.
Copied to your clipboard[AEPMobileCore registerExtensions:@[AEPMobileCampaign.class] completion:nil];
Copied to your clipboard+ (void) registerExtension;
Registration occurs by passing Campaign
to the MobileCore.registerExtensions
API.
Copied to your clipboardMobileCore.registerExtensions([Campaign.self])
Registration occurs by passing AEPMobileCampaign
to the [AEPMobileCore registerExtensions:completion:]
API.
Copied to your clipboard[AEPMobileCore registerExtensions:@[AEPMobileCampaign.class] completion:nil];
Copied to your clipboard+ (void) registerExtension;
resetLinkageFields
Copied to your clipboardstatic func resetLinkageFields()
Copied to your clipboard+ (void) resetLinkageFields;
Copied to your clipboard+ (void) resetLinkageFields;
Copied to your clipboardstatic func resetLinkageFields()
Copied to your clipboard+ (void) resetLinkageFields;
Copied to your clipboard+ (void) resetLinkageFields;
setLinkageFields
Copied to your clipboardstatic func setLinkageFields(_ linkageFields: [String: String])
Copied to your clipboard+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*)
Copied to your clipboard+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields;
Copied to your clipboardstatic func setLinkageFields(_ linkageFields: [String: String])
Copied to your clipboard+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*)
Copied to your clipboard+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields;