Migrating to AEPIdentity reference
This document is a reference comparison of AEPIdentity (3.x) APIs against their equivalent APIs in ACPIdentity (2.x) for an iOS mobile application implementation.

Public Classes

Type
AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
Primary Class
Identity
AEPMobileIdentity
ACPIdentity
Class
MobileCore
AEPMobileCore
ACPCore

Identity extension APIs

For more information, please read the Identity API reference.

appendToUrl

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
static func appendTo(url: URL?, completion: @escaping (URL?, Error?) -> Void)
Copied!
1
+ (void) appendToUrl: (NSURL * _Nullable baseUrl)
2
completion: ^(NSURL * _Nullable urlWithVisitorData, NSError * _Nullable error) completion;
Copied!
1
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;
2
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCompletionHandler: (nullable void (^) (NSURL* __nullable urlWithVersionData, NSError* __nullable error)) completionHandler;
Copied!

extensionVersion

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

getExperienceCloudId

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
static func getExperienceCloudId(completion: @escaping (String?, Error?) -> Void)
Copied!
1
+ (void) getExperienceCloudId: ^(NSString * _Nullable ecid, NSError * _Nullable error) completion;
Copied!
1
+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;
2
+ (void) getExperienceCloudIdWithCompletionHandler: (nonnull void (^) (NSString* __nullable experienceCloudId, NSError* __nullable error)) completionHandler;
Copied!

getIdentifiers

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
static func getIdentifiers(completion: @escaping ([Identifiable]?, Error?) -> Void)
Copied!
1
+ (void) getIdentifiers: ^(NSArray<id<AEPIdentifiables>> * _Nullable identifiers, NSError * _Nullable error) completion;
Copied!
1
+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;
2
+ (void) getIdentifiersWithCompletionHandler: (nonnull void (^) (NSArray<ACPMobileVisitorId*>* __nullable visitorIDs, NSError* __nullable error)) completionHandler;
Copied!

getUrlVariables

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
static func getUrlVariables(completion: @escaping (String?, Error?) -> Void)
Copied!
1
+ (void) getUrlVariables: ^(NSString * _Nullable urlVariables, NSError * _Nullable error) completion:
Copied!
1
+ (void) getUrlVariables: (nonnull void (^) (NSString* __nullable urlVariables)) callback;
2
+ (void) getUrlVariablesWithCompletionHandler: (nonnull void (^) (NSString* __nullable urlVariables, NSError* __nullable error)) completionHandler;
Copied!

setAdvertisingIdentifier

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
public static func setAdvertisingIdentifier(_ identifier: String?)
Copied!
1
+ (void) setAdvertisingIdentifier: (NSString * _Nullable identifier);
Copied!
1
+ (void) setAdvertisingIdentifier: (nullable NSString*) adId;
Copied!

setPushIdentifier

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
public static func setPushIdentifier(_ deviceToken: Data?)
Copied!
1
+ (void) setPushIdentifier: (NSString * _Nullable deviceToken);
Copied!
1
+ (void) setPushIdentifier: (nullable NSData*) deviceToken;
Copied!

syncIdentifier

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
static func syncIdentifier(identifierType: String, identifier: String, authenticationState: MobileVisitorAuthenticationState)
Copied!
1
+ (void) syncIdentifierWithType: (NSString * _Nonnull identifierType)
2
identifier: (NSString * _Nonnull identifier)
3
authentication: (enum AEPAuthenticationState authenticationState);
Copied!
1
+ (void) syncIdentifier: (nonnull NSString*) identifierType
2
identifier: (nonnull NSString*) identifier
3
authentication: (ADBMobileVisitorAuthenticationState) authenticationState;
Copied!

syncIdentifiers

AEP 3.x (Swift)
AEP 3.x (Objective-C)
ACP 2.x (Objective-C)
1
static func syncIdentifiers(identifiers: [String: String]?)
2
static func syncIdentifiers(identifiers: [String: String]?, authenticationState: MobileVisitorAuthenticationState)
Copied!
1
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers);
2
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers)
3
authentication: (enum AEPAuthenticationState authenticationState);
Copied!
1
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers;
2
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers authentication: (ACPMobileVisitorAuthenticationState) authenticationState;
Copied!
Last modified 24d ago