API reference

extensionVersion

The extensionVersion() API returns the version of the Profile extension.

Android

Java

Syntax

@NonNull public static String extensionVersion()
Copied to your clipboard
@NonNull public static String extensionVersion()

Example

String extensionVersion = UserProfile.extensionVersion();
Copied to your clipboard
String extensionVersion = UserProfile.extensionVersion();

Kotlin

Example

val extensionVersion = UserProfile.extensionVersion();
Copied to your clipboard
val extensionVersion = UserProfile.extensionVersion();

iOS

Swift

Syntax

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

Example

let extensionVersion = UserProfile.extensionVersion
Copied to your clipboard
let extensionVersion = UserProfile.extensionVersion

Objective-C

Syntax

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

Example

NSString *extensionVersion = [AEPMobileUserProfile extensionVersion];
Copied to your clipboard
NSString *extensionVersion = [AEPMobileUserProfile extensionVersion];

Java

Syntax

@NonNull public static String extensionVersion()
Copied to your clipboard
@NonNull public static String extensionVersion()

Example

String extensionVersion = UserProfile.extensionVersion();
Copied to your clipboard
String extensionVersion = UserProfile.extensionVersion();

Kotlin

Example

val extensionVersion = UserProfile.extensionVersion();
Copied to your clipboard
val extensionVersion = UserProfile.extensionVersion();

Swift

Syntax

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

Example

let extensionVersion = UserProfile.extensionVersion
Copied to your clipboard
let extensionVersion = UserProfile.extensionVersion

Objective-C

Syntax

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

Example

NSString *extensionVersion = [AEPMobileUserProfile extensionVersion];
Copied to your clipboard
NSString *extensionVersion = [AEPMobileUserProfile extensionVersion];

getUserAttributes

The getUserAttributes() API gets the user profile attributes with the given keys.

Android

Java

Syntax

public static void getUserAttributes(@NonNull final List<String> keys, @NonNull final AdobeCallback<Map<String, Object>> callback)
Copied to your clipboard
public static void getUserAttributes(@NonNull final List<String> keys, @NonNull final 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
    }
});
Copied to your clipboard
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
    }
});

Kotlin

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(listOf("itemsAddedToCart")) {
    object : AdobeCallbackWithError<Map<String, Any?>> {
        override fun fail(adobeError: AdobeError) {
            // your customized code
        }

        override fun call(value: Map<String, Any?>) {
            // your customized code
        }
    }
}
Copied to your clipboard
UserProfile.getUserAttributes(listOf("itemsAddedToCart")) {
    object : AdobeCallbackWithError<Map<String, Any?>> {
        override fun fail(adobeError: AdobeError) {
            // your customized code
        }

        override fun call(value: Map<String, Any?>) {
            // your customized code
        }
    }
}

iOS

Swift

Syntax

static func getUserAttributes(attributeNames: [String], completion: @escaping ([String: Any]?, AEPError) -> Void)
Copied to your clipboard
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
}
Copied to your clipboard
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)
Copied to your clipboard
+ (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
}];
Copied to your clipboard
NSArray *attributes = @[@"itemsAddedToCart"];
[AEPMobileUserProfile getUserAttributesWithAttributeNames:attributes completion:^(NSDictionary<NSString *,id> * _Nullable, enum AEPError) {
        // your customized code
}];

Java

Syntax

public static void getUserAttributes(@NonNull final List<String> keys, @NonNull final AdobeCallback<Map<String, Object>> callback)
Copied to your clipboard
public static void getUserAttributes(@NonNull final List<String> keys, @NonNull final 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
    }
});
Copied to your clipboard
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
    }
});

Kotlin

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(listOf("itemsAddedToCart")) {
    object : AdobeCallbackWithError<Map<String, Any?>> {
        override fun fail(adobeError: AdobeError) {
            // your customized code
        }

        override fun call(value: Map<String, Any?>) {
            // your customized code
        }
    }
}
Copied to your clipboard
UserProfile.getUserAttributes(listOf("itemsAddedToCart")) {
    object : AdobeCallbackWithError<Map<String, Any?>> {
        override fun fail(adobeError: AdobeError) {
            // your customized code
        }

        override fun call(value: Map<String, Any?>) {
            // your customized code
        }
    }
}

Swift

Syntax

static func getUserAttributes(attributeNames: [String], completion: @escaping ([String: Any]?, AEPError) -> Void)
Copied to your clipboard
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
}
Copied to your clipboard
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)
Copied to your clipboard
+ (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
}];
Copied to your clipboard
NSArray *attributes = @[@"itemsAddedToCart"];
[AEPMobileUserProfile getUserAttributesWithAttributeNames:attributes completion:^(NSDictionary<NSString *,id> * _Nullable, enum AEPError) {
        // your customized code
}];

registerExtension

This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.

Use MobileCore.registerExtensions() API instead.

Registers the Profile extension with the Mobile Core extension.

Android

Java

Syntax

@Deprecated
public static void registerExtension()
Copied to your clipboard
@Deprecated
public static void registerExtension()

Example

import com.adobe.marketing.mobile.UserProfile

...

UserProfile.registerExtension();
Copied to your clipboard
import com.adobe.marketing.mobile.UserProfile

...

UserProfile.registerExtension();

Java

Syntax

@Deprecated
public static void registerExtension()
Copied to your clipboard
@Deprecated
public static void registerExtension()

Example

import com.adobe.marketing.mobile.UserProfile

...

UserProfile.registerExtension();
Copied to your clipboard
import com.adobe.marketing.mobile.UserProfile

...

UserProfile.registerExtension();

removeUserAttribute

This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.

Use removeUserAttributes API instead.

Deprecated as of 2.0.0. Please use the removeUserAttributes API instead.

Android

Java

Syntax

@Deprecated
public static void removeUserAttribute(@NonNull final String attributeName)
Copied to your clipboard
@Deprecated
public static void removeUserAttribute(@NonNull final String attributeName)

Example

A retail application wants to remove the itemsAddedToCart user data after the product is purchased.

UserProfile.removeUserAttribute("itemsAddedToCart");
Copied to your clipboard
UserProfile.removeUserAttribute("itemsAddedToCart");

Java

Syntax

@Deprecated
public static void removeUserAttribute(@NonNull final String attributeName)
Copied to your clipboard
@Deprecated
public static void removeUserAttribute(@NonNull final String attributeName)

Example

A retail application wants to remove the itemsAddedToCart user data after the product is purchased.

UserProfile.removeUserAttribute("itemsAddedToCart");
Copied to your clipboard
UserProfile.removeUserAttribute("itemsAddedToCart");

removeUserAttributes

Removes the user profile attributes for the given keys.

Android

Java

Syntax

public static void removeUserAttributes(@NonNull final List<String> attributeNames)
Copied to your clipboard
public static void removeUserAttributes(@NonNull final List<String> attributeNames)

Example

You want to remove username, usertype user data when session timeout occurs.

UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));
Copied to your clipboard
UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));

Kotlin

Example

You want to remove username, usertype user data when session timeout occurs.

UserProfile.removeUserAttributes(listOf("username", "usertype"))
Copied to your clipboard
UserProfile.removeUserAttributes(listOf("username", "usertype"))

iOS

Swift

Syntax

public static void removeUserAttributes(List<String> attributeNames)
Copied to your clipboard
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"));
Copied to your clipboard
UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));

Objective-C

Syntax

+ (void) removeUserAttributesWithAttributeNames:(NSArray<NSString *> * _Nonnull)
Copied to your clipboard
+ (void) removeUserAttributesWithAttributeNames:(NSArray<NSString *> * _Nonnull)

Example

[AEPMobileUserProfile removeUserAttributesWithAttributeNames:@[@"username", @"usertype"]]
Copied to your clipboard
[AEPMobileUserProfile removeUserAttributesWithAttributeNames:@[@"username", @"usertype"]]

Java

Syntax

public static void removeUserAttributes(@NonNull final List<String> attributeNames)
Copied to your clipboard
public static void removeUserAttributes(@NonNull final List<String> attributeNames)

Example

You want to remove username, usertype user data when session timeout occurs.

UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));
Copied to your clipboard
UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));

Kotlin

Example

You want to remove username, usertype user data when session timeout occurs.

UserProfile.removeUserAttributes(listOf("username", "usertype"))
Copied to your clipboard
UserProfile.removeUserAttributes(listOf("username", "usertype"))

Swift

Syntax

public static void removeUserAttributes(List<String> attributeNames)
Copied to your clipboard
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"));
Copied to your clipboard
UserProfile.removeUserAttributes(Arrays.asList("username", "usertype"));

Objective-C

Syntax

+ (void) removeUserAttributesWithAttributeNames:(NSArray<NSString *> * _Nonnull)
Copied to your clipboard
+ (void) removeUserAttributesWithAttributeNames:(NSArray<NSString *> * _Nonnull)

Example

[AEPMobileUserProfile removeUserAttributesWithAttributeNames:@[@"username", @"usertype"]]
Copied to your clipboard
[AEPMobileUserProfile removeUserAttributesWithAttributeNames:@[@"username", @"usertype"]]

updateUserAttribute

This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.

Use updateUserAttributes API instead.

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

Java

Syntax

@Deprecated
public static void updateUserAttribute(@NonNull final String attributeName, @Nullable final Object attributeValue)
Copied to your clipboard
@Deprecated
public static void updateUserAttribute(@NonNull final String attributeName, @Nullable final Object attributeValue)

Example

You want to update username of a user obtained in the log in page:

UserProfile.updateUserAttribute("username", "Will Smith");
Copied to your clipboard
UserProfile.updateUserAttribute("username", "Will Smith");

Java

Syntax

@Deprecated
public static void updateUserAttribute(@NonNull final String attributeName, @Nullable final Object attributeValue)
Copied to your clipboard
@Deprecated
public static void updateUserAttribute(@NonNull final String attributeName, @Nullable final Object attributeValue)

Example

You want to update username of a user obtained in the log in page:

UserProfile.updateUserAttribute("username", "Will Smith");
Copied to your clipboard
UserProfile.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

Java

Syntax

public static void updateUserAttributes(@NonNull final Map<String, Object> attributeMap)
Copied to your clipboard
public static void updateUserAttributes(@NonNull final 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);
Copied to your clipboard
HashMap<String, Object> profileMap = new HashMap<>();
profileMap.put("username","Will Smith");
profileMap.put("usertype","Actor");
UserProfile.updateUserAttributes(profileMap);

Kotlin

Example

You want to update username, usertype of a user obtained in the log in page:

val profileMap = mapOf(
        "username" to "Will Smith",
        "usertype" to "Actor"
    )
UserProfile.updateUserAttributes(profileMap)
Copied to your clipboard
val profileMap = mapOf(
        "username" to "Will Smith",
        "usertype" to "Actor"
    )
UserProfile.updateUserAttributes(profileMap)

iOS

Swift

Syntax

public static func updateUserAttributes(attributeDict: [String: Any])
Copied to your clipboard
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)
Copied to your clipboard
var profileMap = [AnyHashable: Any]()
profileMap["username"] = "will_smith"
profileMap["usertype"] = "Actor"
UserProfile.updateUserAttributes(attributeDict: profileMap)

Objective-C

Syntax

+ (void)updateUserAttributesWithAttributeDict:(NSDictionary<NSString *,id> * _Nonnull)
Copied to your clipboard
+ (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];
Copied to your clipboard
NSMutableDictionary *profileMap = [NSMutableDictionary dictionary];
[profileMap setObject:@"username" forKey:@"will_smith"];
[profileMap setObject:@"usertype" forKey:@"Actor"];
[AEPMobileUserProfile updateUserAttributesWithAttributeDict:profileMap];

Java

Syntax

public static void updateUserAttributes(@NonNull final Map<String, Object> attributeMap)
Copied to your clipboard
public static void updateUserAttributes(@NonNull final 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);
Copied to your clipboard
HashMap<String, Object> profileMap = new HashMap<>();
profileMap.put("username","Will Smith");
profileMap.put("usertype","Actor");
UserProfile.updateUserAttributes(profileMap);

Kotlin

Example

You want to update username, usertype of a user obtained in the log in page:

val profileMap = mapOf(
        "username" to "Will Smith",
        "usertype" to "Actor"
    )
UserProfile.updateUserAttributes(profileMap)
Copied to your clipboard
val profileMap = mapOf(
        "username" to "Will Smith",
        "usertype" to "Actor"
    )
UserProfile.updateUserAttributes(profileMap)

Swift

Syntax

public static func updateUserAttributes(attributeDict: [String: Any])
Copied to your clipboard
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)
Copied to your clipboard
var profileMap = [AnyHashable: Any]()
profileMap["username"] = "will_smith"
profileMap["usertype"] = "Actor"
UserProfile.updateUserAttributes(attributeDict: profileMap)

Objective-C

Syntax

+ (void)updateUserAttributesWithAttributeDict:(NSDictionary<NSString *,id> * _Nonnull)
Copied to your clipboard
+ (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];
Copied to your clipboard
NSMutableDictionary *profileMap = [NSMutableDictionary dictionary];
[profileMap setObject:@"username" forKey:@"will_smith"];
[profileMap setObject:@"usertype" forKey:@"Actor"];
[AEPMobileUserProfile updateUserAttributesWithAttributeDict:profileMap];

Overview

Release notes

Last updated 4/4/2024

Was this helpful?

Yes

API reference

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

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

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

getUserAttributes

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

registerExtension

Java

Java

removeUserAttribute

Java

Java

removeUserAttributes

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

updateUserAttribute

Java

Java

updateUserAttributes

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

extensionVersion

Java