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)

static func appendTo(url: URL?, completion: @escaping (URL?, Error?) -> Void)
Copied to your clipboard
static func appendTo(url: URL?, completion: @escaping (URL?, Error?) -> Void)

AEP 3.x (Objective-C)

+ (void) appendToUrl: (NSURL * _Nullable baseUrl)
                    completion: ^(NSURL * _Nullable urlWithVisitorData, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) appendToUrl: (NSURL * _Nullable baseUrl)
                    completion: ^(NSURL * _Nullable urlWithVisitorData, NSError * _Nullable error) completion;

ACP 2.x (Objective-C)

+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCompletionHandler: (nullable void (^) (NSURL* __nullable urlWithVersionData, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCompletionHandler: (nullable void (^) (NSURL* __nullable urlWithVersionData, NSError* __nullable error)) completionHandler;

static func appendTo(url: URL?, completion: @escaping (URL?, Error?) -> Void)
Copied to your clipboard
static func appendTo(url: URL?, completion: @escaping (URL?, Error?) -> Void)

+ (void) appendToUrl: (NSURL * _Nullable baseUrl)
                    completion: ^(NSURL * _Nullable urlWithVisitorData, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) appendToUrl: (NSURL * _Nullable baseUrl)
                    completion: ^(NSURL * _Nullable urlWithVisitorData, NSError * _Nullable error) completion;

+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCompletionHandler: (nullable void (^) (NSURL* __nullable urlWithVersionData, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCompletionHandler: (nullable void (^) (NSURL* __nullable urlWithVersionData, NSError* __nullable error)) completionHandler;

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;

getExperienceCloudId

AEP 3.x (Swift)

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

AEP 3.x (Objective-C)

+ (void) getExperienceCloudId: ^(NSString * _Nullable ecid, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) getExperienceCloudId: ^(NSString * _Nullable ecid, NSError * _Nullable error) completion;

ACP 2.x (Objective-C)

+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;
+ (void) getExperienceCloudIdWithCompletionHandler: (nonnull void (^) (NSString* __nullable experienceCloudId, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;
+ (void) getExperienceCloudIdWithCompletionHandler: (nonnull void (^) (NSString* __nullable experienceCloudId, NSError* __nullable error)) completionHandler;

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

+ (void) getExperienceCloudId: ^(NSString * _Nullable ecid, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) getExperienceCloudId: ^(NSString * _Nullable ecid, NSError * _Nullable error) completion;

+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;
+ (void) getExperienceCloudIdWithCompletionHandler: (nonnull void (^) (NSString* __nullable experienceCloudId, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;
+ (void) getExperienceCloudIdWithCompletionHandler: (nonnull void (^) (NSString* __nullable experienceCloudId, NSError* __nullable error)) completionHandler;

getIdentifiers

AEP 3.x (Swift)

static func getIdentifiers(completion: @escaping ([Identifiable]?, Error?) -> Void)
Copied to your clipboard
static func getIdentifiers(completion: @escaping ([Identifiable]?, Error?) -> Void)

AEP 3.x (Objective-C)

+ (void) getIdentifiers: ^(NSArray<id<AEPIdentifiables>> * _Nullable identifiers, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) getIdentifiers: ^(NSArray<id<AEPIdentifiables>> * _Nullable identifiers, NSError * _Nullable error) completion;

ACP 2.x (Objective-C)

+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;
+ (void) getIdentifiersWithCompletionHandler: (nonnull void (^) (NSArray<ACPMobileVisitorId*>* __nullable visitorIDs, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;
+ (void) getIdentifiersWithCompletionHandler: (nonnull void (^) (NSArray<ACPMobileVisitorId*>* __nullable visitorIDs, NSError* __nullable error)) completionHandler;

static func getIdentifiers(completion: @escaping ([Identifiable]?, Error?) -> Void)
Copied to your clipboard
static func getIdentifiers(completion: @escaping ([Identifiable]?, Error?) -> Void)

+ (void) getIdentifiers: ^(NSArray<id<AEPIdentifiables>> * _Nullable identifiers, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) getIdentifiers: ^(NSArray<id<AEPIdentifiables>> * _Nullable identifiers, NSError * _Nullable error) completion;

+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;
+ (void) getIdentifiersWithCompletionHandler: (nonnull void (^) (NSArray<ACPMobileVisitorId*>* __nullable visitorIDs, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;
+ (void) getIdentifiersWithCompletionHandler: (nonnull void (^) (NSArray<ACPMobileVisitorId*>* __nullable visitorIDs, NSError* __nullable error)) completionHandler;

getUrlVariables

AEP 3.x (Swift)

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

AEP 3.x (Objective-C)

+ (void) getUrlVariables: ^(NSString * _Nullable urlVariables, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) getUrlVariables: ^(NSString * _Nullable urlVariables, NSError * _Nullable error) completion;

ACP 2.x (Objective-C)

+ (void) getUrlVariables: (nonnull void (^) (NSString* __nullable urlVariables)) callback;
+ (void) getUrlVariablesWithCompletionHandler: (nonnull void (^) (NSString* __nullable urlVariables, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getUrlVariables: (nonnull void (^) (NSString* __nullable urlVariables)) callback;
+ (void) getUrlVariablesWithCompletionHandler: (nonnull void (^) (NSString* __nullable urlVariables, NSError* __nullable error)) completionHandler;

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

+ (void) getUrlVariables: ^(NSString * _Nullable urlVariables, NSError * _Nullable error) completion;
Copied to your clipboard
+ (void) getUrlVariables: ^(NSString * _Nullable urlVariables, NSError * _Nullable error) completion;

+ (void) getUrlVariables: (nonnull void (^) (NSString* __nullable urlVariables)) callback;
+ (void) getUrlVariablesWithCompletionHandler: (nonnull void (^) (NSString* __nullable urlVariables, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getUrlVariables: (nonnull void (^) (NSString* __nullable urlVariables)) callback;
+ (void) getUrlVariablesWithCompletionHandler: (nonnull void (^) (NSString* __nullable urlVariables, NSError* __nullable error)) completionHandler;

setAdvertisingIdentifier

AEP 3.x (Swift)

public static func setAdvertisingIdentifier(_ identifier: String?)
Copied to your clipboard
public static func setAdvertisingIdentifier(_ identifier: String?)

AEP 3.x (Objective-C)

+ (void) setAdvertisingIdentifier: (NSString * _Nullable identifier);
Copied to your clipboard
+ (void) setAdvertisingIdentifier: (NSString * _Nullable identifier);

ACP 2.x (Objective-C)

+ (void) setAdvertisingIdentifier: (nullable NSString*) adId;
Copied to your clipboard
+ (void) setAdvertisingIdentifier: (nullable NSString*) adId;

public static func setAdvertisingIdentifier(_ identifier: String?)
Copied to your clipboard
public static func setAdvertisingIdentifier(_ identifier: String?)

+ (void) setAdvertisingIdentifier: (NSString * _Nullable identifier);
Copied to your clipboard
+ (void) setAdvertisingIdentifier: (NSString * _Nullable identifier);

+ (void) setAdvertisingIdentifier: (nullable NSString*) adId;
Copied to your clipboard
+ (void) setAdvertisingIdentifier: (nullable NSString*) adId;

setPushIdentifier

AEP 3.x (Swift)

public static func setPushIdentifier(_ deviceToken: Data?)
Copied to your clipboard
public static func setPushIdentifier(_ deviceToken: Data?)

AEP 3.x (Objective-C)

+ (void) setPushIdentifier: (NSString * _Nullable deviceToken);
Copied to your clipboard
+ (void) setPushIdentifier: (NSString * _Nullable deviceToken);

ACP 2.x (Objective-C)

+ (void) setPushIdentifier: (nullable NSData*) deviceToken;
Copied to your clipboard
+ (void) setPushIdentifier: (nullable NSData*) deviceToken;

public static func setPushIdentifier(_ deviceToken: Data?)
Copied to your clipboard
public static func setPushIdentifier(_ deviceToken: Data?)

+ (void) setPushIdentifier: (NSString * _Nullable deviceToken);
Copied to your clipboard
+ (void) setPushIdentifier: (NSString * _Nullable deviceToken);

+ (void) setPushIdentifier: (nullable NSData*) deviceToken;
Copied to your clipboard
+ (void) setPushIdentifier: (nullable NSData*) deviceToken;

syncIdentifier

AEP 3.x (Swift)

static func syncIdentifier(identifierType: String, identifier: String, authenticationState: MobileVisitorAuthenticationState)
Copied to your clipboard
static func syncIdentifier(identifierType: String, identifier: String, authenticationState: MobileVisitorAuthenticationState)

AEP 3.x (Objective-C)

+ (void) syncIdentifierWithType: (NSString * _Nonnull identifierType)
                                         identifier: (NSString * _Nonnull identifier)
                                 authentication: (enum AEPAuthenticationState authenticationState);
Copied to your clipboard
+ (void) syncIdentifierWithType: (NSString * _Nonnull identifierType)
                                         identifier: (NSString * _Nonnull identifier)
                                 authentication: (enum AEPAuthenticationState authenticationState);

ACP 2.x (Objective-C)

+ (void) syncIdentifier: (nonnull NSString*) identifierType             
             identifier: (nonnull NSString*) identifier
         authentication: (ADBMobileVisitorAuthenticationState) authenticationState;
Copied to your clipboard
+ (void) syncIdentifier: (nonnull NSString*) identifierType             
             identifier: (nonnull NSString*) identifier
         authentication: (ADBMobileVisitorAuthenticationState) authenticationState;

static func syncIdentifier(identifierType: String, identifier: String, authenticationState: MobileVisitorAuthenticationState)
Copied to your clipboard
static func syncIdentifier(identifierType: String, identifier: String, authenticationState: MobileVisitorAuthenticationState)

+ (void) syncIdentifierWithType: (NSString * _Nonnull identifierType)
                                         identifier: (NSString * _Nonnull identifier)
                                 authentication: (enum AEPAuthenticationState authenticationState);
Copied to your clipboard
+ (void) syncIdentifierWithType: (NSString * _Nonnull identifierType)
                                         identifier: (NSString * _Nonnull identifier)
                                 authentication: (enum AEPAuthenticationState authenticationState);

+ (void) syncIdentifier: (nonnull NSString*) identifierType             
             identifier: (nonnull NSString*) identifier
         authentication: (ADBMobileVisitorAuthenticationState) authenticationState;
Copied to your clipboard
+ (void) syncIdentifier: (nonnull NSString*) identifierType             
             identifier: (nonnull NSString*) identifier
         authentication: (ADBMobileVisitorAuthenticationState) authenticationState;

syncIdentifiers

AEP 3.x (Swift)

static func syncIdentifiers(identifiers: [String: String]?)
static func syncIdentifiers(identifiers: [String: String]?, authenticationState: MobileVisitorAuthenticationState)
Copied to your clipboard
static func syncIdentifiers(identifiers: [String: String]?)
static func syncIdentifiers(identifiers: [String: String]?, authenticationState: MobileVisitorAuthenticationState)

AEP 3.x (Objective-C)

+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers);
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers)
                    authentication: (enum AEPAuthenticationState authenticationState);
Copied to your clipboard
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers);
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers)
                    authentication: (enum AEPAuthenticationState authenticationState);

ACP 2.x (Objective-C)

+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers;
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers authentication: (ACPMobileVisitorAuthenticationState) authenticationState;
Copied to your clipboard
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers;
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers authentication: (ACPMobileVisitorAuthenticationState) authenticationState;

static func syncIdentifiers(identifiers: [String: String]?)
static func syncIdentifiers(identifiers: [String: String]?, authenticationState: MobileVisitorAuthenticationState)
Copied to your clipboard
static func syncIdentifiers(identifiers: [String: String]?)
static func syncIdentifiers(identifiers: [String: String]?, authenticationState: MobileVisitorAuthenticationState)

+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers);
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers)
                    authentication: (enum AEPAuthenticationState authenticationState);
Copied to your clipboard
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers);
+ (void) syncIdentifiers: (NSDictionary<NSString *, NSString *> * _Nullable identifiers)
                    authentication: (enum AEPAuthenticationState authenticationState);

+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers;
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers authentication: (ACPMobileVisitorAuthenticationState) authenticationState;
Copied to your clipboard
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers;
+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers authentication: (ACPMobileVisitorAuthenticationState) authenticationState;

API reference

Overview

Was this helpful?

Yes

Migrating to AEPIdentity reference

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

Identity extension APIs

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

extensionVersion

getExperienceCloudId

getIdentifiers

getUrlVariables

setAdvertisingIdentifier

setPushIdentifier

syncIdentifier

syncIdentifiers

Public Classes

appendToUrl