Profile API reference

extensionVersion
The extensionVersion() API returns the version of the Profile extension.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Flutter
Cordova
Unity
Xamarin
Syntax
public static String extensionVersion()
Example
String extensionVersion = UserProfile.extensionVersion();
Swift
Syntax
static var extensionVersion: String
Example
let extensionVersion = UserProfile.extensionVersion
Objective-C
Syntax
+ (nonnull NSString*) extensionVersion;
Example
NSString *extensionVersion = [AEPMobileUserProfile extensionVersion];
Swift
Syntax
static var extensionVersion: String
Example
let extensionVersion  = ACPUserProfile.extensionVersion()
Objective-C
Syntax
+ (nonnull NSString*) extensionVersion;
Example
NSString *extensionVersion = [ACPUserProfile extensionVersion];
JavaScript
ACPUserProfile.extensionVersion().then(extensionVersion => console.log("AdobeExperienceSDK: ACPUserProfile version: " + extensionVersion));
Dart
String extensionVersion = await FlutterACPUserProfile.extensionVersion;
Cordova
ACPUserProfile.extensionVersion(function(version) {  
   console.log("ACPUserProfile version: " + version);
}, function(error) {  
   console.log(error);  
});
C#
string extensionVersion = ACPUserProfile.ExtensionVersion();
C#
string extensionVersion = ACPUserProfile.ExtensionVersion();
getUserAttributes
The getUserAttributes() API gets the user profile attributes with the given keys.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
Cordova
Flutter
Xamarin
Syntax
public static void getUserAttributes(List<String> keys, AdobeCallback<Map<String, Object>> callback)
callback is invoked after the customer attributes are available.
Example
A retail application wants to get the itemsAddedToCart user data when processing checkout.
When AdobeCallbackWithError is provided, if the operation times out (5s) or an unexpected error occurs, the fail method is called with the appropriate AdobeError.
UserProfile.getUserAttributes(Arrays.asList("itemsAddedToCart"), new AdobeCallbackWithError<Map<String, Object>>() {
            @Override
            public void fail(AdobeError adobeError) {
                // your customized code
            }
            @Override
            public void call(Map<String, Object> stringObjectMap) {
                     // your customized code
            }
        });
Swift
Syntax
static func getUserAttributes(attributeNames: [String], completion: @escaping ([String: Any]?, AEPError) -> Void)
completion is the callback function which will be called with user attributes.
Example
A retail application wants to get the itemsAddedToCart user data when processing checkout.
When the callback is provided, if the operation times out (5s) or an unexpected error occurs, the completion method is called with the appropriate AEPError.
UserProfile.getUserAttributes(attributeNames: ["itemsAddedToCart"]) { attributes, error in
// your customized code
}
Objective-C
Syntax
+ (void)getUserAttributesWithAttributeNames:(NSArray<NSString *> * _Nonnull) comletion:^(NSDictionary<NSString *,id> * _Nullable, enum AEPError)
Example
NSArray *attributes = @[@"itemsAddedToCart"];
[AEPMobileUserProfile getUserAttributesWithAttributeNames:attributes completion:^(NSDictionary<NSString *,id> * _Nullable, enum AEPError) {
        // your customized code
}];
Swift
Syntax
static func getUserAttributes(_ attributeNames: [String]?, withCompletionHandler completionHandler:([AnyHashable : Any]?, Error?) -> Void)
completionHandler is invoked after the customer attributes are available, or error if an unexpected error occurs or the request times out. The default timeout is 5s.
Example
A retail application wants to get the itemsAddedToCart user data when processing checkout.
ACPUserProfile.getUserAttributes(["itemsAddedToCart"], withCompletionHandler: {(dict: [AnyHashable: Any]?, error: Error?) -> Void in
              // your customized code
})
Objective-C
Syntax
+ (void) getUserAttributes: (nullable NSArray <NSString*>*) attributNames withCompletionHandler: (nonnull void (^) (NSDictionary* __nullable userAttributes, NSError* _Nullable error)) completionHandler
Example
[ACPUserProfile getUserAttributes:attributes withCompletionHandler:^(NSDictionary* dict, NSError* error){
    // your customized code
    }];
Syntax
ACPUserProfile.getUserAttributes = function(attributeNames, success, fail);
attributeNames is an array of strings containing the names of user profile attributes to retrieve.
success is a callback containing the retrieved user profile attributes.
fail is a callback containing error information if the getUserAttributes API was executed with errors.
Example
A retail application wants to get the itemsAddedToCart user data when processing checkout.
var attributeNames = new Array();
attributeNames.push("itemsAddedToCart");
ACPUserProfile.getUserAttributes(attributeNames, handleCallback, handleError);
Syntax
static Future<String> getUserAttributes(List<String> attributeKeys) async
attributeKeys is an array of strings containing the names of user profile attributes to retrieve.
Example
A retail application wants to get the itemsAddedToCart user data when processing checkout.
try {
  result = await FlutterACPUserProfile.getUserAttributes(["itemsAddedToCart"]);
} on PlatformException {
  log("Failed to get the user attributes");
}
Syntax
Android
public unsafe static void GetUserAttributes (IList<string> keys, IAdobeCallback callback);
keys is an IList containing the names of user profile attributes to retrieve.
iOS
public unsafe static void GetUserAttributes (string[] attributNames, [BlockProxy (typeof(ObjCRuntime.Trampolines.NIDActionArity2V0))] Action<NSDictionary, NSError> completionHandler);
attributNames is an array of strings containing the names of user profile attributes to remove.
Example
A retail application wants to get the itemsAddedToCart user data when processing checkout.
Android
var keysToRetrieve = new List<string>();
keysToRetrieve.Add("itemsAddedToCart");
ACPUserProfile.GetUserAttributes(keysToRetrieve, new AdobeCallback());
​
class AdobeCallback : Java.Lang.Object, IAdobeCallbackWithError
{
  public void Fail(AdobeError error)
  {
    Console.WriteLine("GetUserAttributes error: " + error.ToString());
  }
​
  public void Call(Java.Lang.Object retrievedAttributes)
  {
    if (retrievedAttributes != null)
    {
      var attributesDictionary = new Android.Runtime.JavaDictionary<string, object>(retrievedAttributes.Handle, Android.Runtime.JniHandleOwnership.DoNotRegister);
      foreach (KeyValuePair<string, object> pair in attributesDictionary)
      {
        Console.WriteLine("[ " + pair.Key + " : " + pair.Value + " ]");
      }
    }
    else
    {
      Console.WriteLine("GetUserAttributes callback is null.");
    }
  }
}
iOS
var callback = new Action<NSDictionary, NSError>(handleCallback);
var keysToRetrieve = new string[] { "itemsAddedToCart" };
ACPUserProfile.GetUserAttributes(keysToRetrieve, callback);
​
private void handleCallback(NSDictionary content, NSError error)
{
  if (error != null)
  {
    Console.WriteLine("GetUserAttributes error: " + error.DebugDescription);
  }
  else if (content == null)
  {
    Console.WriteLine("GetUserAttributes callback is null.");
  }
  else
  {
    var attributesDictionary = (NSDictionary)content;
    foreach (KeyValuePair<NSObject, NSObject> pair in attributesDictionary)
    {
      Console.WriteLine("[ " + pair.Key + " : " + pair.Value + " ]");
    }
  }
}
registerExtension
Registers the Profile extension with the Mobile Core extension.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
Java
Syntax
public static void registerExtension()
Example
import com.adobe.marketing.mobile.UserProfile
​
...
​
UserProfile.registerExtension();
In iOS, the registration occurs by passing UserProfile extension to the MobileCore.registerExtensions API.
Swift
Syntax
static func registerExtensions(_ extensions: [NSObject.Type], 
                               _ completion: (() -> Void)? = nil)
Example
import AEPUserProfile
​
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  
  MobileCore.registerExtensions([UserProfile.self])
  // Override point for customization after application launch.
  return true;
}
Objective-C
Syntax
+ (void) registerExtensions: (NSArray<Class*>* _Nonnull) extensions 
                 completion: (void (^ _Nullable)(void)) completion;
Example
@import AEPUserProfile;
​
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  
  [AEPMobileCore registerExtensions:@[AEPMobileUserProfile.class] completion:nil];
  // Override point for customization after application launch.
  return YES;
}
Register the Identity extension in your app's didFinishLaunchingWithOptions function:
Swift
Syntax
static func registerExtensions()
Example
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  ACPUserProfile.registerExtension()
  // Override point for customization after application launch.
  return true;
}
Objective-C
Syntax
+ (void) registerExtension;
Example
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [ACPUserProfile registerExtension];
  // Override point for customization after application launch.
  return YES;
}
removeUserAttribute
Removes the user profile attribute for the given key.
Android
iOS (ACP 2.x)
Cordova
Flutter
Xamarin
Syntax
public static void removeUserAttribute(String attributeName)
Example
A retail application wants to remove the itemsAddedToCart user data after the product is purchased.
UserProfile.removeUserAttribute("itemsAddedToCart");
Swift
Syntax
static func removeUserAttribute(_ attributeName: String)
Example
A retail application wants to remove the itemsAddedToCart user data after the product is purchased.
ACPUserProfile.removeUserAttribute("itemsAddedToCart");
Objective-C
Syntax
+ (void) removeUserAttribute: (nonnull NSString*) key
Example
[ACPUserProfile removeUserAttribute:@"itemsAddedToCart"];
Syntax
ACPUserProfile.removeUserAttribute = function(attributeName, success, fail);
attributeName is a string containing the name of the user profile attribute to remove.
success is a callback containing a general success message if the removeUserAttribute API executed without any errors.
fail is a callback containing error information if the removeUserAttribute API was executed with errors.
Example
A retail application wants to remove the itemsAddedToCart user data after the product is purchased.
ACPUserProfile.removeUserAttribute("itemsAddedToCart", handleCallback, handleError);
Syntax
static Future<void> removeUserAttribute(String attributeName) async
attributeName is a string containing the name of the user profile attribute to remove.
Example
A retail application wants to remove the itemsAddedToCart user data after the product is purchased.
FlutterACPUserProfile.removeUserAttribute("itemsAddedToCart");
Syntax
Android
public unsafe static void RemoveUserAttribute (string attributeName);
attributeName is a string containing the name of the user profile attribute to remove.
iOS
public static void RemoveUserAttribute (string attributeName);
attributeName is a string containing the name of the user profile attribute to remove.
Example
A retail application wants to remove the itemsAddedToCart user data after the product is purchased.
ACPUserProfile.RemoveUserAttribute("itemsAddedToCart");
removeUserAttributes
Removes the user profile attributes for the given keys.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
Cordova
Flutter
Xamarin
Syntax
public static void removeUserAttributes(List<String> attributeNames)
Example
You want to remove username, usertype user data when session timeout occurs.
UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));
Swift
Syntax
public static void removeUserAttributes(List<String> attributeNames)
Example
You want to remove username, usertype user data when session timeout occurs.
UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));
Objective-C
Syntax
+ (void) removeUserAttributesWithAttributeNames:(NSArray<NSString *> * _Nonnull)
Example
[AEPMobileUserProfile removeUserAttributesWithAttributeNames:@[@"username", @"usertype"]]
Swift
Syntax
static func removeUserAttributes(_ attributeNames: [String]?)
Example
You want to remove username, usertype user data when session timeout occurs.
ACPUserProfile.removeUserAttributes(["username","usertype"]);
Objective-C
Syntax
+ (void) removeUserAttributes: (nonnull NSArray <NSString*>*) attributeNames
Example
[ACPUserProfile removeUserAttributes:@[@"username", @"usertype"]]
Syntax
ACPUserProfile.removeUserAttributes = function(attributeNames, success, fail);
attributeNames is an array of strings containing the names of user profile attributes to remove.
success is a callback containing a general success message if the removeUserAttributes API executed without any errors.
fail is a callback containing error information if the removeUserAttributes API was executed with errors.
Example
You want to remove username, usertype user data when session timeout occurs.
var attributeNames = new Array();
attributeNames.push("username");
attributeNames.push("usertype");
ACPUserProfile.removeUserAttributes(attributeNames, handleCallback, handleError);
Syntax
static Future<void> removeUserAttributes(List<String> attributeName) async
attributeName is an array of strings containing the names of user profile attributes to remove.
Example
You want to remove username, usertype user data when session timeout occurs.
FlutterACPUserProfile.removeUserAttributes(["username", "usertype"])
Syntax
Android
public unsafe static void RemoveUserAttributes (IList<string> attributeNames);
attributeNames is an IList containing the names of user profile attributes to remove.
iOS
public static void RemoveUserAttributes (string[] attributeNames);
attributeNames is an array of strings containing the names of user profile attributes to remove.
Example
You want to remove username, usertype user data when session timeout occurs.
Android
var attributes = new List<string>();
attributes.Add("username");
attributes.Add("usertype");
ACPUserProfile.RemoveUserAttributes(attributes);
iOS
string[] attributes = new string[] { "username", "usertype" };
ACPUserProfile.RemoveUserAttributes(attributes);
updateUserAttribute
Sets the user profile attributes key and value and allows you to create or update a user profile attribute.
Remember the following information:
If the attribute does not exist, it will be created.
If the attribute exists, the value will be updated.
A null attribute value removes the attribute.
Android
iOS (ACP 2.x)
Cordova
Flutter
Xamarin
Syntax
public static void updateUserAttribute(String attributeName, 
                                       Object attributeValue)
Example
You want to update username of a user obtained in the log in page :
UserProfile.updateUserAttribute("username", "Will Smith");
Swift
Syntax
static func updateUserAttribute(_ attributeName: String, withValue attributeValue: String?)
Example
You want to update username of a user obtained in the log in page:
ACPUserProfile.updateUserAttribute("username", withValue: "Will Smith");
Objective-C
Syntax
+ (void) updateUserAttribute: (nonnull NSString*) attributeName withValue: (nullable NSString*) attributeValue;
Example
[ACPUserProfile updateUserAttribute:@"username" withValue:@"Will Smith"];
Syntax
ACPUserProfile.updateUserAttribute = function(attributeName, attributeValue, success, fail);
attributeName is a string containing the name of the user profile attribute to create or update.
attributeValue must be a string, number, or array containing the user profile attribute value.
success is a callback containing a general success message if the updateUserAttribute API executed without any errors.
fail is a callback containing error information if the updateUserAttribute API was executed with errors.
Example
You want to update username of a user obtained in the log in page :
ACPUserProfile.updateUserAttribute("username", "Will Smith", handleCallback, handleError);
Syntax
static Future<void> updateUserAttribute(String attributeName, String attributeValue) async
attributeName is a string containing the name of the user profile attribute to create or update.
attributeValue must be a string, number, or array containing the user profile attribute value.
Example
You want to update username of a user obtained in the log in page :
FlutterACPUserProfile.updateUserAttribute("username", "Will Smith");
Syntax
Android
public unsafe static void UpdateUserAttribute (string attributeName, Java.Lang.Object attributeValue);
attributeName is a string containing the name of the user profile attribute to create or update.
attributeValue must be a String, Integer, Boolean, Double, Array, or Map containing the user profile attribute value. Custom objects cannot be saved as a UserProfile attribute.
iOS
public static void UpdateUserAttribute (string attributeName, string attributeValue);
attributeName is a string containing the name of the user profile attribute to create or update.
attributeValue is a string containing the user profile attribute value.
Example
You want to update username of a user obtained in the log in page :
ACPUserProfile.updateUserAttribute("username", "Will Smith");
updateUserAttributes
Sets the user profile attributes key and value.
Allows you to create/update a batch of user profile attributes:
String, Integer, Boolean, Double, Array, Map are valid type of user profile attributes.
Custom objects cannot be saved as a UserProfile attribute.
If the attribute does not exist, it is created.
If the attribute already exists, the value is updated.
A null attribute value will remove the attribute.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
Cordova
Flutter
Xamarin
Syntax
public static void updateUserAttributes(Map<String, Object> attributeMap)
Example
You want to update username, usertype of a user obtained in the log in page :
HashMap<String, Object> profileMap = new HashMap<>();
profileMap.put("username","Will Smith");
profileMap.put("usertype","Actor");
UserProfile.updateUserAttributes(profileMap);
Swift
Syntax
public static func updateUserAttributes(attributeDict: [String: Any])
Example
You want to update username, usertype of a user obtained in the log in page :
var profileMap = [AnyHashable: Any]()
profileMap["username"] = "will_smith"
profileMap["usertype"] = "Actor"
UserProfile.updateUserAttributes(attributeDict: profileMap)
Objective-C
Syntax
+ (void)updateUserAttributesWithAttributeDict:(NSDictionary<NSString *,id> * _Nonnull)
Example
NSMutableDictionary *profileMap = [NSMutableDictionary dictionary];
[profileMap setObject:@"username" forKey:@"will_smith"];
[profileMap setObject:@"usertype" forKey:@"Actor"];
[AEPMobileUserProfile updateUserAttributesWithAttributeDict:profileMap];
Swift
Syntax
static func updateUserAttributes(_ attributeMap: [AnyHashble: Any])
Example
You want to update username, usertype of a user obtained in the log in page :
var profileMap = [AnyHashable: Any]()
profileMap["username"] = "will_smith"
profileMap["usertype"] = "Actor"
ACPUserProfile.updateUserAttributes(profileMap)
Objective-C
Syntax
+ (void) updateUserAttributes: (nonnull NSDictionary*) attributeMap
Example
NSMutableDictionary *profileMap = [NSMutableDictionary dictionary];
[profileMap setObject:@"username" forKey:@"will_smith"];
[profileMap setObject:@"usertype" forKey:@"Actor"];