Migrating to AEPTarget reference

This document is a reference comparison of AEPTarget(3.x) APIs against their equivalent ACPTarget (2.x) APIs for an iOS mobile application implementation.

The AEPTarget extension is implemented purely in Swift and is compatible with the AEPCore Swift SDK. To ensure a smooth transition from the ACPTarget 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 an explanation beyond showing API differences is necessary, it will be captured as an info hint within that API's section.

Public classes

Type	AEP 3.x (Swift)	AEP 3.x (Objective-C)	ACP 2.x (Objective-C)
Primary Class (Module)	Target	AEPMobileTarget	ACPTarget
Class	TargetRequest	AEPTargetRequestObject	ACPTargetRequestObject
Class	TargetPrefetch	AEPTargetPrefetchObject	ACPTargetPrefetchObject
Class	TargetOrder	AEPTargetOrder	ACPTargetOrder
Class	TargetParameters	AEPTargetParameters	ACPTargetParameters
Class	TargetProduct	AEPTargetProduct	ACPTargetProduct

Public APIs

clearPrefetchCache

AEP 3.x (Swift)

static func clearPrefetchCache()
Copied to your clipboard
static func clearPrefetchCache()

AEP 3.x (Objective-C)

+ (void) clearPrefetchCache;
Copied to your clipboard
+ (void) clearPrefetchCache;

ACP 2.x (Objective-C)

+ (void) clearPrefetchCache;
Copied to your clipboard
+ (void) clearPrefetchCache;

static func clearPrefetchCache()
Copied to your clipboard
static func clearPrefetchCache()

+ (void) clearPrefetchCache;
Copied to your clipboard
+ (void) clearPrefetchCache;

+ (void) clearPrefetchCache;
Copied to your clipboard
+ (void) clearPrefetchCache;

clickedLocation

AEP 3.x (Swift)

static func clickedLocation(_ name: String, targetParameters: TargetParameters? = nil)
Copied to your clipboard
static func clickedLocation(_ name: String, targetParameters: TargetParameters? = nil)

AEP 3.x (Objective-C)

+ (void) clickedLocation: (NSString* _NonNull) name
    withTargetParameters: (AEPTargetParameters* _Nullable) targetParameters;
Copied to your clipboard
+ (void) clickedLocation: (NSString* _NonNull) name
    withTargetParameters: (AEPTargetParameters* _Nullable) targetParameters;

ACP 2.x (Objective-C)

+ (void) locationClickedWithName: (nonnull NSString*) name
                targetParameters: (nullable ACPTargetParameters*) parameters;
Copied to your clipboard
+ (void) locationClickedWithName: (nonnull NSString*) name
                targetParameters: (nullable ACPTargetParameters*) parameters;

static func clickedLocation(_ name: String, targetParameters: TargetParameters? = nil)
Copied to your clipboard
static func clickedLocation(_ name: String, targetParameters: TargetParameters? = nil)

+ (void) clickedLocation: (NSString* _NonNull) name
    withTargetParameters: (AEPTargetParameters* _Nullable) targetParameters;
Copied to your clipboard
+ (void) clickedLocation: (NSString* _NonNull) name
    withTargetParameters: (AEPTargetParameters* _Nullable) targetParameters;

+ (void) locationClickedWithName: (nonnull NSString*) name
                targetParameters: (nullable ACPTargetParameters*) parameters;
Copied to your clipboard
+ (void) locationClickedWithName: (nonnull NSString*) name
                targetParameters: (nullable ACPTargetParameters*) parameters;

extensionVersion

AEP 3.x (Swift)

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

AEP 3.x (Objective-C)

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

ACP 2.x (Objective-C)

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

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

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

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

getThirdPartyId

AEP 3.x (Swift)

static func getThirdPartyId(_ completion: @escaping (String?, Error?) -> Void)
Copied to your clipboard
static func getThirdPartyId(_ completion: @escaping (String?, Error?) -> Void)

AEP 3.x (Objective-C)

+ (void) getThirdPartyId: (nonnull void (^) (NSString* _Nullable thirdPartyId,  NSError* _Nullable error)) completion;
Copied to your clipboard
+ (void) getThirdPartyId: (nonnull void (^) (NSString* _Nullable thirdPartyId,  NSError* _Nullable error)) completion;

ACP 2.x (Objective-C)

+ (void) getThirdPartyId: (nonnull void (^) (NSString* __nullable thirdPartyId)) callback;
Copied to your clipboard
+ (void) getThirdPartyId: (nonnull void (^) (NSString* __nullable thirdPartyId)) callback;

static func getThirdPartyId(_ completion: @escaping (String?, Error?) -> Void)
Copied to your clipboard
static func getThirdPartyId(_ completion: @escaping (String?, Error?) -> Void)

+ (void) getThirdPartyId: (nonnull void (^) (NSString* _Nullable thirdPartyId,  NSError* _Nullable error)) completion;
Copied to your clipboard
+ (void) getThirdPartyId: (nonnull void (^) (NSString* _Nullable thirdPartyId,  NSError* _Nullable error)) completion;

+ (void) getThirdPartyId: (nonnull void (^) (NSString* __nullable thirdPartyId)) callback;
Copied to your clipboard
+ (void) getThirdPartyId: (nonnull void (^) (NSString* __nullable thirdPartyId)) callback;

getTntId

AEP 3.x (Swift)

static func getTntId(_ completion: @escaping (String?, Error?) -> Void)
Copied to your clipboard
static func getTntId(_ completion: @escaping (String?, Error?) -> Void)

AEP 3.x (Objective-C)

+ (void) getTntId: (nonnull void (^) (NSString* _Nullable tntId,  NSError* _Nullable error)) completion;
Copied to your clipboard
+ (void) getTntId: (nonnull void (^) (NSString* _Nullable tntId,  NSError* _Nullable error)) completion;

ACP 2.x (Objective-C)

+ (void) getTntId: (nonnull void (^) (NSString* __nullable tntId)) callback;
Copied to your clipboard
+ (void) getTntId: (nonnull void (^) (NSString* __nullable tntId)) callback;

static func getTntId(_ completion: @escaping (String?, Error?) -> Void)
Copied to your clipboard
static func getTntId(_ completion: @escaping (String?, Error?) -> Void)

+ (void) getTntId: (nonnull void (^) (NSString* _Nullable tntId,  NSError* _Nullable error)) completion;
Copied to your clipboard
+ (void) getTntId: (nonnull void (^) (NSString* _Nullable tntId,  NSError* _Nullable error)) completion;

+ (void) getTntId: (nonnull void (^) (NSString* __nullable tntId)) callback;
Copied to your clipboard
+ (void) getTntId: (nonnull void (^) (NSString* __nullable tntId)) callback;

prefetchContent

AEP 3.x (Swift)

static func prefetchContent(_ prefetchArray: [TargetPrefetch], with targetParameters: TargetParameters? = nil, _ completion: ((Error?) -> Void)?)
Copied to your clipboard
static func prefetchContent(_ prefetchArray: [TargetPrefetch], with targetParameters: TargetParameters? = nil, _ completion: ((Error?) -> Void)?)

AEP 3.x (Objective-C)

+ (void) prefetchContent: (NSArray<AEPTargetPrefetchObject*>* _NonNull) prefetchArray
          withParameters: (AEPTargetParameters* _Nullable) targetParameters
                callback: (nullable void (^) (NSError* _Nullable error)) completion;
Copied to your clipboard
+ (void) prefetchContent: (NSArray<AEPTargetPrefetchObject*>* _NonNull) prefetchArray
          withParameters: (AEPTargetParameters* _Nullable) targetParameters
                callback: (nullable void (^) (NSError* _Nullable error)) completion;

ACP 2.x (Objective-C)

+ (void) prefetchContent: (nonnull NSArray<ACPTargetPrefetchObject*>*) prefetchObjectArray
          withParameters: (nullable ACPTargetParameters*) parameters
                callback: (nullable void (^) (NSError* _Nullable error)) callback;
Copied to your clipboard
+ (void) prefetchContent: (nonnull NSArray<ACPTargetPrefetchObject*>*) prefetchObjectArray
          withParameters: (nullable ACPTargetParameters*) parameters
                callback: (nullable void (^) (NSError* _Nullable error)) callback;

static func prefetchContent(_ prefetchArray: [TargetPrefetch], with targetParameters: TargetParameters? = nil, _ completion: ((Error?) -> Void)?)
Copied to your clipboard
static func prefetchContent(_ prefetchArray: [TargetPrefetch], with targetParameters: TargetParameters? = nil, _ completion: ((Error?) -> Void)?)

+ (void) prefetchContent: (NSArray<AEPTargetPrefetchObject*>* _NonNull) prefetchArray
          withParameters: (AEPTargetParameters* _Nullable) targetParameters
                callback: (nullable void (^) (NSError* _Nullable error)) completion;
Copied to your clipboard
+ (void) prefetchContent: (NSArray<AEPTargetPrefetchObject*>* _NonNull) prefetchArray
          withParameters: (AEPTargetParameters* _Nullable) targetParameters
                callback: (nullable void (^) (NSError* _Nullable error)) completion;

+ (void) prefetchContent: (nonnull NSArray<ACPTargetPrefetchObject*>*) prefetchObjectArray
          withParameters: (nullable ACPTargetParameters*) parameters
                callback: (nullable void (^) (NSError* _Nullable error)) callback;
Copied to your clipboard
+ (void) prefetchContent: (nonnull NSArray<ACPTargetPrefetchObject*>*) prefetchObjectArray
          withParameters: (nullable ACPTargetParameters*) parameters
                callback: (nullable void (^) (NSError* _Nullable error)) callback;

registerExtension

AEP 3.x (Swift)

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

MobileCore.registerExtensions([Target.self])
Copied to your clipboard
MobileCore.registerExtensions([Target.self])

AEP 3.x (Objective-C)

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

[AEPMobileCore registerExtensions:@[AEPMobileTarget.class] completion:nil];
Copied to your clipboard
[AEPMobileCore registerExtensions:@[AEPMobileTarget.class] completion:nil];

ACP 2.x (Objective-C)

[ACPTarget registerExtension];
Copied to your clipboard
[ACPTarget registerExtension];

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

MobileCore.registerExtensions([Target.self])
Copied to your clipboard
MobileCore.registerExtensions([Target.self])

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

[AEPMobileCore registerExtensions:@[AEPMobileTarget.class] completion:nil];
Copied to your clipboard
[AEPMobileCore registerExtensions:@[AEPMobileTarget.class] completion:nil];

[ACPTarget registerExtension];
Copied to your clipboard
[ACPTarget registerExtension];

retrieveLocationContent

AEP 3.x (Swift)

static func retrieveLocationContent(_ requestArray: [TargetRequest], with targetParameters: TargetParameters? = nil)
Copied to your clipboard
static func retrieveLocationContent(_ requestArray: [TargetRequest], with targetParameters: TargetParameters? = nil)

AEP 3.x (Objective-C)

(void) retrieveLocationContent: (NSArray<AEPTargetRequestObject*>* _NonNull) requestsArray
                withParameters: (AEPTargetParameters* _Nullable) targetParameters;
Copied to your clipboard
(void) retrieveLocationContent: (NSArray<AEPTargetRequestObject*>* _NonNull) requestsArray
                withParameters: (AEPTargetParameters* _Nullable) targetParameters;

ACP 2.x (Objective-C)

+ (void) retrieveLocationContent: (nonnull NSArray<ACPTargetRequestObject*>*) requests
                  withParameters: (nullable ACPTargetParameters*) parameters;
Copied to your clipboard
+ (void) retrieveLocationContent: (nonnull NSArray<ACPTargetRequestObject*>*) requests
                  withParameters: (nullable ACPTargetParameters*) parameters;

static func retrieveLocationContent(_ requestArray: [TargetRequest], with targetParameters: TargetParameters? = nil)
Copied to your clipboard
static func retrieveLocationContent(_ requestArray: [TargetRequest], with targetParameters: TargetParameters? = nil)

(void) retrieveLocationContent: (NSArray<AEPTargetRequestObject*>* _NonNull) requestsArray
                withParameters: (AEPTargetParameters* _Nullable) targetParameters;
Copied to your clipboard
(void) retrieveLocationContent: (NSArray<AEPTargetRequestObject*>* _NonNull) requestsArray
                withParameters: (AEPTargetParameters* _Nullable) targetParameters;

+ (void) retrieveLocationContent: (nonnull NSArray<ACPTargetRequestObject*>*) requests
                  withParameters: (nullable ACPTargetParameters*) parameters;
Copied to your clipboard
+ (void) retrieveLocationContent: (nonnull NSArray<ACPTargetRequestObject*>*) requests
                  withParameters: (nullable ACPTargetParameters*) parameters;

setPreviewRestartDeepLink

AEP 3.x (Swift)

static func setPreviewRestartDeepLink(_ deeplink: URL)
Copied to your clipboard
static func setPreviewRestartDeepLink(_ deeplink: URL)

AEP 3.x (Objective-C)

+ (void) setPreviewRestartDeeplink: (NSURL* _NonNull) deeplink;
Copied to your clipboard
+ (void) setPreviewRestartDeeplink: (NSURL* _NonNull) deeplink;

ACP 2.x (Objective-C)

+ (void) setPreviewRestartDeeplink: (nonnull NSURL*) deeplink;
Copied to your clipboard
+ (void) setPreviewRestartDeeplink: (nonnull NSURL*) deeplink;

static func setPreviewRestartDeepLink(_ deeplink: URL)
Copied to your clipboard
static func setPreviewRestartDeepLink(_ deeplink: URL)

+ (void) setPreviewRestartDeeplink: (NSURL* _NonNull) deeplink;
Copied to your clipboard
+ (void) setPreviewRestartDeeplink: (NSURL* _NonNull) deeplink;

+ (void) setPreviewRestartDeeplink: (nonnull NSURL*) deeplink;
Copied to your clipboard
+ (void) setPreviewRestartDeeplink: (nonnull NSURL*) deeplink;

setThirdPartyId

AEP 3.x (Swift)

static func setThirdPartyId(_ id: String?)
Copied to your clipboard
static func setThirdPartyId(_ id: String?)

AEP 3.x (Objective-C)

+ (void) setThirdPartyId: (NSString* _Nullable) thirdPartyId;
Copied to your clipboard
+ (void) setThirdPartyId: (NSString* _Nullable) thirdPartyId;

ACP 2.x (Objective-C)

+ (void) setThirdPartyId: (nullable NSString*) thirdPartyId;
Copied to your clipboard
+ (void) setThirdPartyId: (nullable NSString*) thirdPartyId;

static func setThirdPartyId(_ id: String?)
Copied to your clipboard
static func setThirdPartyId(_ id: String?)

+ (void) setThirdPartyId: (NSString* _Nullable) thirdPartyId;
Copied to your clipboard
+ (void) setThirdPartyId: (NSString* _Nullable) thirdPartyId;

+ (void) setThirdPartyId: (nullable NSString*) thirdPartyId;
Copied to your clipboard
+ (void) setThirdPartyId: (nullable NSString*) thirdPartyId;

API reference

Release notes

Was this helpful?

Yes

Migrating to AEPTarget reference

Public classes.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Public APIs

clearPrefetchCache.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

clickedLocation

extensionVersion

getThirdPartyId

getTntId

prefetchContent

registerExtension

retrieveLocationContent

setPreviewRestartDeepLink

setThirdPartyId

Public classes

clearPrefetchCache