Package io.appmetrica.analytics.profile

Class UserProfile

java.lang.Object

io.appmetrica.analytics.profile.UserProfile

public class UserProfile
extends Object

The class to store a user profile.

User profile is a set of user attributes. User profile details are displayed in the AppMetrica User profiles report.

The UserProfile object should be passed to the AppMetrica server by using the AppMetrica.reportUserProfile(UserProfile) method.

AppMetrica has some predefined attributes. You can use them or create own custom attributes.

User profiles are stored on the AppMetrica server.

EXAMPLE:

     
      UserProfile userProfile = new UserProfile.Builder()
                             .apply(Attribute.customString("foo_attribute").withValue("baz_value"))
                             .apply(Attribute.name().withName("John"))
                             .apply(Attribute.gender().withValue(GenderAttribute.Gender.MALE))
                             .apply(Attribute.notificationEnabled().withValue(false))
                             .build();
      AppMetrica.reportUserProfile(userProfile);
      AppMetrica.setProfileId("id_1");
     
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserProfile.Builder	Builder class for UserProfile objects.

Method Summary

Modifier and Type	Method	Description
List<UserProfileUpdate<? extends io.appmetrica.analytics.impl.profile.UserProfileUpdatePatcher>>	getUserProfileUpdates()
static UserProfile.Builder	newBuilder()	Creates the new instance of UserProfile.Builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getUserProfileUpdates

@NonNull
public List<UserProfileUpdate<? extends io.appmetrica.analytics.impl.profile.UserProfileUpdatePatcher>> getUserProfileUpdates()

Returns:

list of all UserProfileUpdate objects

newBuilder

@NonNull
public static UserProfile.Builder newBuilder()

Creates the new instance of UserProfile.Builder.

Returns:

The UserProfile.Builder object.