User profile
Additionally to basic methods, you can observe and change the user profiles data. User profile is the set or properties describing the user. User properties can be divided into 4 groups:
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the identifier which was set during the initialization is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Basic set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
Crossplatform or custom user identifier. If this identifier is not set by developer, then the device identifier is used.
Automatically collected properties, including data about user's device, geography, app version, SDK, and some other data which can be received from SDK.
Default set of user properties, which can be set by developer. The set of this parameters works with separate methods. This set includes the data of user's name, sex, age, e-mail, phone-number and url of user picture. Also this set includes the mark of user as cheater.
Custom set of user properties. In this case developer sets any user data he/she needs to know. The data is set in key-value format and can be numeric, string, array or boolean.
You can segment users by all the properties in My Apps section of an application.
Cross-platform user ID
This method is used for user initialization in the applications that are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the setUserID method call.
If your cross-platform application is supposed to be used without cross-platform authorization, don't use the setUserID method or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will be used until the real cross-platform identifier is assigned to the user.
Attention! If your application allows user to relogin (changing the user during the working session of the application), then the setUserID method should be called just after the authorization. You don't need to call the SDK initialization one more time.
/**
* Initializes the user with the specified cross-platform identifier
* @param NSString userId - unique cross-platform user ID used
* for user identification on your server.
*/
[DevToDev setUserId: (NSString *) userId];
To see which identifier is used at the moment:
/**
* Returns current cross-platform user id
* @return userId - current cross-platform user id
*/
[DevToDev getUserId];
This method is used for user initialization in the applications which are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the setUserID method call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the setUserID method or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will we used until the real cross-platform identifier assigns to the user.
Attention! If your application allows user to relogin (changing the user during the working session of application), then the setUserID method should be called just after the authorization. You don't need to call the SDK initialization one more time.
/**
* Initializes the user with the specified cross-platform identifier
* @param String userId - unique cross-platform user ID used
* for user identification on your server.
*/
DevToDev.setUserId(String userId);
To see which identifier is used at the moment:
/**
* Returns current cross-platform user id
* @return userId - current cross-platform user id (or null, if sdk not initialized)
*/
DevToDev.getUserId();
This method is used for user initialization in the applications which are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identiticator from the previous session will be used since the SDK initialization moment till the UserID property call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the UserID property or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will we used until the real cross-platform identifier assigns to the user.
Attention! If your application allows user to relogin (changing the user during the working session of application), then the UserID property should be called just after the authorization. You don't need to call the SDK initialization one more time.
/**
* Initializes the user with the specified cross-platform identifier
* property allows to get and to set unique cross-platform user ID used
* for user identification on your server.
*/
DevToDev.SDK.UserId = userId;
This property also allows you to see which identifier is used at the moment.
This method is used for user initialization in the applications which are the parts of cross-platform project. You also can use this identifier in non-crossplatform projects, but in your app the own unique user identifier is used.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the setCrossplatformUserId method call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the setCrossplatformUserId method or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will be used until the real cross-platform identifier assigns to the user.
/**
* Initializes the user with the specified cross-platform identifier
* @param {string} crossplatformUserId - unique cross-platform user ID used
* for user identification on your server.
*/
devtodev.setCrossplatformUserId(crossplatformUserId);
Attention! If your application allows user to relogin (changing the user during the working session of application), then the setCrossplatformUserId method should be called just after the authorization. You don't need to call the SDK initialization one more time.
To see which identifier is used at the moment:
/**
* Returns current cross-platform user id
* @return crossPlatformUserId - current cross-platform user id
*/
devtodev.getCrossplatformUserId();
This method is used for user initialization in the applications which are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the UserID property call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the UserID property or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will we used until the real cross-platform identifier assigns to the user.
Attention! If your application allows user to relogin (changing the user during the working session of application), then the UserID property should be called just after the authorization. You don't need to call the SDK initialization one more time.
/// <summary>
/// Initializes the user with the specified cross-platform identifier
/// property allows to get and to set unique cross-platform user ID used
/// for user identification on your server.</summary>
DevToDev.Analytics.UserId = userId;
This property also allows you to see which identifier is used at the moment.
This method is used for user initialization in the applications which are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the setUserID method call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the setUserID method or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will we used until the real cross-platform identifier assigns to the user.
Attention! If your application allows user to relogin (changing the user during the working session of application), then the setUserID method should be called just after the authorization. You don't need to call the SDK initialization one more time.
/**
* Initializes the user with the specified cross-platform identifier
* @param NSString userId - unique cross-platform user ID used
* for user identification on your server.
*/
[DevToDev setUserId: (NSString *) userId];
To see which identifier is used at the moment:
/**
* Returns current cross-platform user id
* @return userId - current cross-platform user id
*/
[DevToDev getUserId];
This method is used for user initialization in the applications which are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the setUserID method call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the setUserID method or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will we used until the real cross-platform identifier assigns to the user.
Attention! If your application allows user to relogin (changing the user during the working session of application), then the setUserID method should be called just after the authorization. You don't need to call the SDK initialization one more time.
/**
* Initializes the user with the specified cross-platform identifier
* @param userId - unique cross-platform user ID used for user identification on your server.
*/
DevToDev.setUserId(userId:String);
To see which identifier is used at the moment:
/**
* Returns current cross-platform user id
* @return userId - current cross-platform user id (string or null, if sdk not initialized)
*/
DevToDev.getUserId();
This method is used for user initialization in the applications which are the parts of cross-platform project.
We recommend you to apply this method before the SDK initialization, otherwise the user identifier from the previous session will be used since the SDK initialization moment till the setUserID method call.
If your cross-platform application supposes to be used without cross-platform authorization, don't use the setUserID method or use the empty string ("") as the user identifier. SDK will assign the unique identifier to user. This identifier will we used until the real cross-platform identifier assigns to the user.
Attention! If your application allows user to relogin (changing the user during the working session of application), then the setUserID method should be called just after the authorization. You don't need to call the SDK initialization one more time.
Blueprint
Code
// Initializes the user with the specified cross-platform identifier
// FString activeUserId - unique cross-platform user id
FAnalytics::Get().GetDefaultConfiguredProvider()->SetUserID(FString activeUserId);
To see which identifier is used at the moment:
Blueprint
Code
// Returns current cross-platform user id
FAnalytics::Get().GetDefaultConfiguredProvider()->GetUserID();
Replace Cross-platform user ID
If it is possible to replace the user identifier in your application (for example, to make changes in the login/user id for a particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
/**
* Replaces current cross-platform user id
* Attention! Don't use this method if you're going to perform the user's relogin.
* @param NSString prevUserId - previous cross-platform user ID
* @param NSString userId - new cross-platform user ID
*/
[DevToDev replaceUserId: (NSString *) prevUserId to: (NSString *) userId];
If it is possible to replace the user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
/**
* Replaces current cross-platform user id
* Attention! Don't use this method if you're going to perform the user's relogin.
* @param String prevUserId - previous cross-platform user ID
* @param String userId - new cross-platform user ID
*/
DevToDev.replaceUserId(String prevUserId, String userId);
If it is possible to replace the user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
/**
* Replaces current cross-platform user id
* Attention! Don't use this method if you're going to perform the user's relogin.
* <param name="prevUserId">Old user identifier</param>
* <param name="userId">New user identifier</param>
*/
DevToDev.SDK.ReplaceUserId(string prevUserId, string userId);
If it is possible to replace the cross-platform user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin!
/**
* Replaces current cross-platform user id
* Attention! Don't use this method if you're going to perform the user's relogin.
* @param {string} newCrossPlatformID - new cross-platform user ID
*/
devtodev.replaceCrossplatformUserId(newCrossPlatformID);
If it is possible to replace the user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
/// <summary> Replaces current cross-platform user id.
/// Attention! Don't use this method if you're going to perform the user's relogin.</summary>
/// <param name="prevUserId"> Old user identifier </param>
/// <param name="userId"> New user identifier </param>
DevToDev.Analytics.ReplaceUserId(string prevUserId, string userId);
If it is possible to replace the user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
/**
* Replaces current cross-platform user id
* Attention! Don't use this method if you're going to perform the user's relogin.
* @param NSString prevUserId - previous cross-platform user ID
* @param NSString userId - new cross-platform user ID
*/
[DevToDev replaceUserId: (NSString *) prevUserId to: (NSString *) userId];
If it is possible to replace the user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
/**
* Replaces current cross-platform user id
* Attention! Don't use this method if you're going to perform the user's relogin.
* @param prevUserId - previous cross-platform user ID
* @param userId - new cross-platform user ID
*/
DevToDev.replaceUserId(prevUserId:String, userId:String);
If it is possible to replace the user identifier in your application (say, to make changes in the login/user id for particular user), use this method at the moment of replacing the identifier. Attention! Don't use this method if you're going to perform the user's relogin.
Blueprint
Code
// Replaces cross-platform user id
// FString from - current user id
// FString to - new user id
UDevToDevBlueprintFunctionLibrary::ReplaceUserId(const FString& from, const FString& to);
Current user level
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the setCurrentLevel method just after the user initialization (using the setUserID method).
Attention! Don't use the setCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
/**
* Initializes the current user level. Required if level feature used in the app.
* @param NSUInteger level - current game level of the player.
*/
[DevToDev setCurrentLevel: (NSUInteger) level];
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the setCurrentLevel method just after the user initialization (using the setUserID method).
Attention! Don't use the setCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
/**
* Initializes the current user level. Required if level feature used in the app.
* @param int level - current game level of the player.
*/
DevToDev.setCurrentLevel(int level);
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the SetCurrentLevel method just after the user initialization (using the UserID method).
Attention! Don't use the SetCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
/**
* Initializes the current user level. Required if level feature used in the app.
* <param name="level">Current game level of the player</param>
*/
DevToDev.SDK.SetCurrentLevel(int level);
If your app uses the user's level mark, we recommend to use this method after every SDK initialization, as soon as data of user's level is available to the application.
/**
* Initializes the current user level. Required if level feature used in the app.
* @param {number} currentUserLevel - current game level of the player.
*/
devtodev.setCurrentLevel(currentUserLevel);
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the SetCurrentLevel method just after the user initialization (using the UserID method).
Attention! Don't use the SetCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
/// <summary> Initializes the current user level. Required if level feature used in the app. </summary>
/// <param name="level"> current game level of the player </param>
DevToDev.Analytics.SetCurrentLevel(int level);
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the setCurrentLevel method just after the user initialization (using the setUserID method).
Attention! Don't use the setCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
/**
* Initializes the current user level. Required if level feature used in the app.
* @param NSUInteger level - current game level of the player.
*/
[DevToDev setCurrentLevel: (NSUInteger) level];
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the setCurrentLevel method just after the user initialization (using the setUserID method).
Attention! Don't use the setCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
/**
* Initializes the current user level. Required if level feature used in the app.
* @param level - current game level of the player.
*/
DevToDev.setCurrentLevel(level:int);
This method is used in cross-platform applications and applications with data synchronization.
This method is required for user's level data initialization. We recommend you to use the setCurrentLevel method just after the user initialization (using the setUserID method).
Attention! Don't use the setCurrentLevel method at the moment of user's level up. We recommend you to use the levelUp method in this case.
Blueprint
Code
// Initializes the current user level
// int32 level - current user level
UDevToDevBlueprintFunctionLibrary::SetCurrentLevel(int32 level)
Cheater
In case you have your own methods of determining cheaters in the application, you can have such users marked. Payments made by them will not be taken into account in the statistics.
/**
* Mark user if it's cheater.
* @param BOOL isCheater - true if user is a cheater
*/
DevToDev.activeUser.cheater = isCheater;
/**
* Mark user if it's cheater.
* @param boolean isCheater - true if user is a cheater
*/
DevToDev.getActivePlayer().setCheater(boolean isCheater);
/**
* Mark user if it's cheater.
* <param name="isCheater">true if user is a cheater</param>
*/
DevToDev.SDK.ActiveUser.SetCheater(boolean isCheater);
/**
* Mark user if it's cheater.
* @param {boolean} isCheater - true if user is a cheater
*/
devtodev.user.cheater(isCheater);
/// <summary> Mark user if it's cheater. </summary>
/// <param name="isCheater"> true if user is a cheater </param>
DevToDev.Analytics.ActiveUser.Cheater = isCheater;
/**
* Mark user if it's cheater.
* @param BOOL isCheater - true if user is a cheater
*/
DevToDev.activeUser.cheater = isCheater;
/**
* Mark user if it's cheater.
* @param isCheater - true if user is a cheater
*/
DevToDev.getActiveUser().SetCheater(isCheater:Boolean);
Blueprint
Code
UPeopleLibrary::Cheater(bool cheater);
Name
User's name. Default user profile property.
/**
* Track user's name
* @param NSString name - User's name.
*/
DevToDev.activeUser.name = name;
/**
* Track user's name
* @param String name - User's name
*/
DevToDev.getActivePlayer().setName(String name);
/**
* Track user's name
* <param name="name">User's name</param>
*/
DevToDev.SDK.ActiveUser.SetName(string name);
/**
* Track user's name
* @param {string} name - User's name.
*/
devtodev.user.name(name);
/// <summary> Track user's name </summary>
/// <param name="name"> User's name </param>
DevToDev.Analytics.ActiveUser.Name = name;
/**
* Track user's name
* @param NSString name - User's name.
*/
DevToDev.activeUser.name = name;
/**
* Track user's name
* @param name - User's name.
*/
DevToDev.getActiveUser().SetName(name:String);
Blueprint
--
Code
UPeopleLibrary::Name(const FString& name);
Age
User's age in years. Default user profile property.
/**
* Track user's age
* @param NSNumber age - User's age
*/
DevToDev.activeUser.age = age;
/**
* Track user's age
* @param int age - User's age
*/
DevToDev.getActivePlayer().setAge(int age);
/**
* Track user's age
* <param name="age">User's age</param>
*/
DevToDev.SDK.ActiveUser.SetAge(int age);
/**
* Track user's age
* @param {number} age - User's age.
*/
devtodev.user.age(age);
/// <summary> Track user's age </summary>
/// <param name="age"> User's age </param>
DevToDev.Analytics.ActiveUser.Age = age;
/**
* Track user's age
* @param NSNumber age - User's age
*/
DevToDev.activeUser.age = age;
/**
* Track user's age
* @param age - User's age in years
*/
DevToDev.getActiveUser().SetAge(age:int);
Blueprint
Code
UPeopleLibrary::Age(int32 age);
Gender
User's gender. Default user profile property.
/**
* Track user's
* @param DTDGender gender - User's gender. (Unknown, Male, Female).
*/
DevToDev.activeUser.gender = gender;
/**
* Track user's gender
* @param Gender gender - User's gender. (Unknown, Male, Female).
*/
DevToDev.getActivePlayer().setGender(Gender gender);
/**
* Track user's gender.
* <param name="gender">User's gender. (Unknown, Male, Female)</param>
*/
DevToDev.SDK.ActiveUser.SetGender(DevToDev.Gender gender);
/**
* Track user's gender
* @param {number} gender - User's gender. (0 - Unknown, 1 - Male, 2 - Female).
*/
devtodev.user.gender(gender);
/// <summary> Track user's gender </summary>
/// <param name="gender"> User's gender. (Unknown, Male, Female) </param>
DevToDev.Analytics.ActiveUser.Gender = gender;
/**
* Track user's
* @param DTDGender gender - User's gender. (Unknown, Male, Female).
*/
DevToDev.activeUser.gender = gender;
/**
* Track user's
* @param gender - User's gender. (Unknown == 0, Male == 1, Female == 2).
*/
DevToDev.getActiveUser().SetGender(gender:int);
Blueprint
Code
UPeopleLibrary::Gender(const FString& InGender);
E-mail
User's e-mail. Default user profile property.
/**
* Track user's e-mail
* @param NSString email - User's e-mail.
*/
DevToDev.activeUser.email = email;
/**
* Track user's e-mail
* @param String email - User's e-mail.
*/
DevToDev.getActivePlayer().setEmail(String email);
/**
* Track user's e-mail
* <param name="email">User's e-mail</param>
*/
DevToDev.SDK.ActiveUser.SetEmail(string email);
/**
* Track user's e-mail
* @param {string} email - User's e-mail.
*/
devtodev.user.email(email);
/// <summary> Track user's e-mail </summary>
/// <param name="email"> User's e-mail </param>
DevToDev.Analytics.ActiveUser.Email = email;
/**
* Track user's e-mail
* @param NSString email - User's e-mail.
*/
DevToDev.activeUser.email = email;
/**
* Track user's e-mail
* @param email - User's e-mail.
*/
DevToDev.getActiveUser().SetEmail(email:String);
Blueprint
Code
UPeopleLibrary::Email(const FString& email);
Phone number
User's phone. Default user profile property.
/**
* Track user's phone number
* @param NSString phoneNumber - User's phone number.
*/
DevToDev.activeUser.phone = phoneNumber;
/**
* Track user's phone number
* @param String phoneNumber - User's phone number.
*/
DevToDev.getActivePlayer().setPhone(String phoneNumber);
/**
* Track user's phone number
* <param name="phoneNumber">User's phone number</param>
*/
DevToDev.SDK.ActiveUser.SetPhone(string phoneNumber);
/**
* Track user's phone number
* @param {string} phone_number - User's phone number.
*/
devtodev.user.phone(phone_number);
/// <summary> Track user's phone number </summary>
/// <param name="phoneNumber"> User's phone number </param>
DevToDev.Analytics.ActiveUser.Phone = phoneNumber;
/**
* Track user's phone number
* @param NSString phoneNumber - User's phone number.
*/
DevToDev.activeUser.phone = phoneNumber;
/**
* Track user's phone number
* @param phoneNumber - User's phone number.
*/
DevToDev.getActiveUser().SetPhone(phoneNumber:String);
Blueprint
Code
UPeopleLibrary::Phone(const FString& phone);
Photo
User's photo URL. Default user profile property.
/**
* Track user's photo URL
* @param NSString photoUrl - User's photo URL.
*/
DevToDev.activeUser.photo = photoUrl;
/**
* Track user's photo URL
* @param String photoUrl - User's photo url.
*/
DevToDev.getActivePlayer().setPhoto(String photoUrl);
/**
* Track user's photo URL
* <param name="photoUrl">User's photo url</param>
*/
DevToDev.SDK.ActiveUser.SetPhoto(string photoUrl);
/**
* Track user's photo URL
* @param {string} photo_url - User's phone number.
*/
devtodev.user.photo(photo_url);
/// <summary> Track user's photo URL </summary>
/// <param name="photoUrl"> User's photo url </param>
DevToDev.Analytics.ActiveUser.Photo = photoUrl;
/**
* Track user's photo URL
* @param NSString photoUrl - User's photo URL.
*/
DevToDev.activeUser.photo = photoUrl;
/**
* Track user's photo URL
* @param photoUrl - User's photo url.
*/
DevToDev.getActiveUser().SetPhoto(photoUrl:String);
Blueprint
Code
UPeopleLibrary::Photo(const FString& photo);
Custom user property
Set properties on the current user profile.
/**
* Set properties on a user data.
*
* ### Usage:
* [DevToDev.activeUser setUserDataWithKey:@"Hair color" andValue: @"copper red"];
* properties can have string, integer, date or list type
*
* @param NSString key - the name of the property
* @param {*} value - a value to set on the given property
*/
[DevToDev.activeUser setUserDataWithKey: (NSString *) key andValue: (id) value];
/**
* Set multiple properties at once
*
* ### Usage:
* [DevToDev.activeUser setUserData:@{
* @"Hair color" : @"blonde",
* @"Last payment" : 100,
* @"Last order" : @[
* @"Coloring",
* @"Hair Straightening"
* ],
* @"Order date" : [NSDate date]
* }];
* properties can have string, integer, date or list type
*
* @param NSDictionary userData - an associative array of names and values.
*/
[DevToDev.activeUser setUserData: (NSDictionary *) userData];
/**
* Set properties on a user data.
*
* ### Usage:
* DevToDev.getActivePlayer().setUserData("Hair color", "copper red");
* properties can have String, Number or Collection type
*
* @param String key - the name of the property
* @param {*} value - a value to set on the given property
*/
DevToDev.getActivePlayer().setUserData(String key, Object value);
/**
* Set multiple properties at once
*
* ### Usage:
* final Map<String, Object> userData = new HashMap<String, Object>();
* userData.put("Hair color", "blonde");
* userData.put("Last payment", 100);
* final List<Object> lastOrder = new ArrayList<Object>();
* lastOrder.add("Coloring");
* lastOrder.add("Hair Straightening");
* userData.put("Last order", lastOrder);
* DevToDev.getActivePlayer().setUserData(userData);
* properties can have String, Number or Collection type
*
* @param Map<String, Object> userData - an associative array of names and values.
*/
DevToDev.getActivePlayer().setUserData(final Map<String, Object> userData);
/**
* Set properties on a user data.
*
* ### Usage:
* DevToDev.SDK.ActiveUser.SetUserData("Hair color", "copper red");
* properties can have string, int, double or List<object> type
*
* <param name="key">property name</param>
* <param name="value">a value to set on the given property</param>
*/
DevToDev.SDK.ActiveUser.SetUserData(string key, object value);
/**
* Set multiple properties at once
*
* ### Usage:
* Dictionary<string, object> userData = new Dictionary<string, object>();
* userData.Add("Hair color", "blonde");
* userData.Add("Last payment", 100);
* List<object> lastOrder = List<object>();
* lastOrder.Add("Coloring");
* lastOrder.Add("Hair Straightening");
* userData.Add("Last order", lastOrder);
* DevToDev.SDK.ActiveUser.SetUserData(userData);
* properties can have string, int, double or List<object> type
*
* <param name="userData">an associative array of names and values</param>
*/
DevToDev.SDK.ActiveUser.SetUserData(Dictionary<string, object> userData);
/*
* Set properties on a user data.
*
* ### Usage:
* devtodev.user.set('Hair color', 'copper red');
*
* // to set multiple properties at once
* devtodev.user.set({
* 'Hair color': 'blonde',
* 'Last payment': 100,
* 'Last order': ['Coloring','Hair Straightening'],
* 'Order date': new Date()
* });
* // properties can be strings, integers, dates, or lists
*
* @param {Object|String} prop If a string, this is the name of the property. If an object, this is an associative array of names and values.
* @param {*} [val] A value to set on the given property
*/
devtodev.user.set(prop, val);
/// <summary> Set properties on a user data. </summary>
/// <example> Usage:
///
/// DevToDev.Analytics.ActiveUser.SetUserData("Hair color", "copper red");
/// //properties can have string, int, double or List<object> type
///
/// </example>
/// <param name="key">property name</param>
/// <param name="value">a value to set on the given property</param>
DevToDev.Analytics.ActiveUser.SetUserData(string key, object value);
/// <summary> Set multiple properties at once. </summary>
/// <example> Usage:
///
/// Dictionary<string, object> userData = new Dictionary<string, object>();
/// userData.Add("Hair color", "blonde");
/// userData.Add("Last payment", 100);
/// List<object> lastOrder = List<object>();
/// lastOrder.Add("Coloring");
/// lastOrder.Add("Hair Straightening");
/// userData.Add("Last order", lastOrder);
/// DevToDev.Analytics.ActiveUser.SetUserData(userData);
/// //properties can have string, int, double or List<object> type
///
/// </example>
/// <param name="userData">an associative array of names and values</param>
DevToDev.Analytics.ActiveUser.SetUserData(Dictionary<string, object> userData);
/**
* Set properties on a user data.
*
* ### Usage:
* [DevToDev.activeUser setUserDataWithKey:@"Hair color" andValue: @"copper red"];
* properties can have string, integer, date or list type
*
* @param NSString key - the name of the property
* @param {*} value - a value to set on the given property
*/
[DevToDev.activeUser setUserDataWithKey: (NSString *) key andValue: (id) value];
/**
* Set multiple properties at once
*
* ### Usage:
* [DevToDev.activeUser setUserData:@{
* @"Hair color" : @"blonde",
* @"Last payment" : 100,
* @"Last order" : @[
* @"Coloring",
* @"Hair Straightening"
* ],
* @"Order date" : [NSDate date]
* }];
* properties can have string, integer, date or list type
*
* @param NSDictionary userData - an associative array of names and values.
*/
[DevToDev.activeUser setUserData: (NSDictionary *) userData];
/**
* Set properties on a user data.
* ### Usage:
* DevToDev.getActiveUser().SetUserData("Hair color", "copper red");
* properties can have String, Number or Array type
*
* @param key - the name of the property
* @param value - a value to set on the given property
*/
DevToDev.getActiveUser().SetUserData(key:String, value:Object);
/**
* Set multiple properties at once
*
* ### Usage:
* var userData:Dictionary = new Dictionary();
* userData["Hair color"] = "blonde";
* userData["Last payment"] = 100;
* var lastOrder:Array = new Array();
* lastOrder.push("Coloring");
* lastOrder.push("Hair Straightening");
* userData["Last order"] = lastOrder;
* DevToDev.getActiveUser().SetUserDataMany(userData);
* properties can have String, Number or Collection type
*
* @param userData - an associative array of names and values.
*/
DevToDev.getActiveUser().SetUserDataMany(userData:Dictionary);
Blueprint
Code
UPeopleLibrary::SetUserData(const TArray<FAnalyticsEventAttr>& Attributes);
Increment of the custom property
Increments the given numeric properties by the given values.
/**
* Increments or decrements numeric user's properties.
* ### Usage:
* [DevToDev.activeUser incrementWithKey: @"Rounds played" andValue: 1];
*
* // to decrement a counter, pass a negative number
* [DevToDev.activeUser incrementWithKey: @"Rounds played" andValue: -1];
*
* @param NSString key - the name of the property
* @param NSNumber value - an amount to increment the given property
*/
[DevToDev.activeUser incrementWithKey: (NSString *) key andValue: (id) value];
/**
* Increments or decrements multiple numeric user's properties at once.
* ### Usage:
* [DevToDev.activeUser increment: @{
* @"Rounds played" : 1,
* @"Enemies killed" : 6
* }];
*
* @param NSDictionary values - an associative array of property names and numeric values.
*/
[DevToDev.activeUser increment: (NSDictionary *) values];
/**
* Increments or decrements numeric user's properties.
* ### Usage:
* DevToDev.getActivePlayer().increment("Rounds played", 1);
*
* // to decrement a counter, pass a negative number
* DevToDev.getActivePlayer().increment("Rounds played", -1);
*
* @param String key - the name of the property
* @param Number value - an amount to increment the given property
*/
DevToDev.getActivePlayer().increment(String key, Number value);
/**
* Increments or decrements multiple numeric user's properties at once.
* ### Usage:
* final Map<String, Number> data = new HashMap<String, Number>();
* data.put("Rounds played", 1);
* data.put("Enemies killed", 6);
* DevToDev.getActivePlayer().increment(data);
*
* @param Map<String, Number> values - an associative array of property names and numeric values.
*/
DevToDev.getActivePlayer().increment(final Map<String, Number> data);
/**
* Increments or decrements numeric user's properties.
* ### Usage:
* DevToDev.SDK.ActiveUser.Increment("Rounds played", 1);
*
* // to decrement a counter, pass a negative number
* DevToDev.SDK.ActiveUser.Increment("Rounds played", -1);
*
* <param name="key">property name</param>
* <param name="value">an amount to increment the given property(int or double)</param>
*/
DevToDev.SDK.ActiveUser.Increment(string key, object value);
/**
* Increments or decrements multiple numeric user's properties at once.
* ### Usage:
* Dictionary<string, object> data = new Dictionary<string, object>();
* data.Add("Rounds played", 1);
* data.Add("Enemies killed", 6);
* DevToDev.SDK.ActiveUser.Increment(data);
*
* <param name="values">an associative array of property names and numeric(int, double) values</param>
*/
DevToDev.SDK.ActiveUser.Increment(Dictionary<string, object> values);
/*
* Increments or decrements numeric user's properties.
* ### Usage:
* devtodev.user.increment('Rounds played', 1);
* // or if you're just incrementing a counter by 1, you can simply do
* devtodev.user.increment('Rounds played');
*
* // to decrement a counter, pass a negative number
* devtodev.user.increment('Rounds played', -1);
*
* // you can increment multiple properties at once:
* devtodev.user.increment({
* 'Rounds played': 1,
* 'Enemies killed': 6
* });
* @param {Object|String} prop If a string, this is the name of the property. If an object, this is an associative array of names and numeric values.
* @param {Number} [val] An amount to increment the given property
*/
devtodev.user.increment(prop, val);
/// <summary> Increments or decrements numeric user's properties.</summary>
/// <example> Usage:
///
/// DevToDev.Analytics.ActiveUser.Increment("Rounds played", 1);
/// //to decrement a counter, pass a negative number
/// DevToDev.Analytics.ActiveUser.Increment("Rounds played", -1);
///
/// </example>
/// <param name="key">property name</param>
/// <param name="value">an amount to increment the given property(int or double)</param>
DevToDev.Analytics.ActiveUser.Increment(string key, object value);
/// <summary> Increments or decrements multiple numeric user's properties at once.</summary>
/// <example> Usage:
///
/// Dictionary<string, object> data = new Dictionary<string, object>();
/// data.Add("Rounds played", 1);
/// data.Add("Enemies killed", 6);
/// DevToDev.Analytics.ActiveUser.Increment(data);
///
/// </example>
/// <param name="values">an associative array of property names and numeric(int, double) values</param>
DevToDev.Analytics.ActiveUser.Increment(Dictionary<string, object> values);
/**
* Increments or decrements numeric user's properties.
* ### Usage:
* [DevToDev.activeUser incrementWithKey: @"Rounds played" andValue: 1];
*
* // to decrement a counter, pass a negative number
* [DevToDev.activeUser incrementWithKey: @"Rounds played" andValue: -1];
*
* @param NSString key - the name of the property
* @param NSNumber value - an amount to increment the given property
*/
[DevToDev.activeUser incrementWithKey: (NSString *) key andValue: (id) value];
/**
* Increments or decrements multiple numeric user's properties at once.
* ### Usage:
* [DevToDev.activeUser increment: @{
* @"Rounds played" : 1,
* @"Enemies killed" : 6
* }];
*
* @param NSDictionary values - an associative array of property names and numeric values.
*/
[DevToDev.activeUser increment: (NSDictionary *) values];
/**
* Increments or decrements numeric user's properties.
* ### Usage:
* DevToDev.getActiveUser().Increment("Rounds played", 1);
*
* // to decrement a counter, pass a negative number
* DevToDev.getActiveUser().Increment("Rounds played", -1);
*
* @param key - the name of the property
* @param value - an amount to increment the given property
*/
DevToDev.getActiveUser().Increment(key:String, value:Number);
/**
* Increments or decrements multiple numeric user's properties at once.
* ### Usage:
* var data:Dictionary = new Dictionary();
* data["Rounds played"] = 1;
* data["Enemies killed"] 6;
* DevToDev.getActivePlayer().IncrementMany(data);
*
* @param values - an associative array of property names and numeric values.
*/
DevToDev.getActiveUser().IncrementMany(data:Dictionary);
Blueprint
Code
UPeopleLibrary::IncrementUserData(const TArray<FAnalyticsEventAttr>& Attributes);
Append to custom property
Adds values to a list-valued property. If the property does not currently exist, it will be created with the given list as it's value. If the property exists and is not list-valued, the append will be ignored.
/**
* Append values to list properties.
* @param NSString key - property name
* @param {NSString|NSNumber|NSNull|NSArray|NSDictionary|NSDate|NSURL} value - appending value
*/
[DevToDev.activeUser appendWithKey: (NSString *) key andValue: (id) value];
/**
* Multiple append list-valued properties at once
* @param NSDictionary values - an associative array of property names and values.
*/
[DevToDev.activeUser append: (NSDictionary *) values];
/**
* Append values to list properties.
* @param String key - property name
* @param {String|Number|null|Collection|Map|Date|Url} value - appending value
*/
DevToDev.getActivePlayer().append(String key, Object value);
/**
* Multiple append list-valued properties at once
* @param Map<String, Object> values - an associative array of property names and values.
*/
DevToDev.getActivePlayer().append(final Map<String, Object> data);
/**
* Append values to list properties.
* <param name="key">property name</param>
* <param name="value">appending value of type {string|int|double|List}</param>
*/
DevToDev.SDK.ActiveUser.Append(string key, object value);
/**
* Multiple append list-valued properties at once
* <param name="values">an associative array of property names and values</param>
*/
DevToDev.SDK.ActiveUser.Append(Dictionary<string, object> values);
/// <summary> Append values to list properties. </summary>
/// <param name="key"> Property name </param>
/// <param name="value"> Appending value of type {string|int|double|List} </param>
DevToDev.Analytics.ActiveUser.AppendUserData(string key, object value);
/// <summary> Multiple append list-valued properties at once </summary>
/// <param name="values"> An associative array of property names and values </param>
DevToDev.Analytics.ActiveUser.AppendUserData(Dictionary<string, object> values);
/**
* Append values to list properties.
* @param NSString key - property name
* @param {NSString|NSNumber|NSNull|NSArray|NSDictionary|NSDate|NSURL} value - appending value
*/
[DevToDev.activeUser appendWithKey: (NSString *) key andValue: (id) value];
/**
* Multiple append list-valued properties at once
* @param NSDictionary values - an associative array of property names and values.
*/
[DevToDev.activeUser append: (NSDictionary *) values];
/**
* Append values to list properties.
* @param key - property name
* @param value - appending value (String|Number|Array)
*/
DevToDev.getActiveUser().AppendUserData(key:String, value:Object);
/**
* Multiple append list-valued properties at once
* @param values - an associative array of property names and values.
*/
DevToDev.getActiveUser().AppendUserDataMany(data:Dictionary);
Union with custom property
Adds values to a list-valued property only if they are not already present in the list. If the property does not currently exist, it will be created with the given list as it's value. If the property exists and is not list-valued, the union will be ignored.
/**
* Union a given list with a list-valued property, excluding duplicate values.
* @param NSString key - property name
* @param {NSString|NSNumber|NSNull|NSArray|NSDictionary|NSDate|NSURL} value - appending value
*/
[DevToDev.activeUser unionWithKey: (NSString *) key andValue: (id) value];
/**
* Multiple union of a given lists with a list-valued properties at once
* @param NSDictionary values - an associative array of property names and values.
*/
[DevToDev.activeUser unionWithData: (NSDictionary *) values];
/**
* Union a given list with a list-valued property, excluding duplicate values.
* @param String key - property name
* @param {String|Number|null|Collection|Map|Date|Url} value - appending value
*/
DevToDev.getActivePlayer().union(String key, Object value);
/**
* Multiple union of a given lists with a list-valued properties at once
* @param Map values - an associative array of property names and values.
*/
/**
* Union a given list with a list-valued property, excluding duplicate values.
* <param name="key">property name</param>
* <param name="value">appending value of type {string|int|double|List}</param>
*/
DevToDev.SDK.ActiveUser.Union(string key, object value);
/**
* Multiple union of a given lists with a list-valued properties at once
* <param name="values">an associative array of property names and values</param>
*/
DevToDev.SDK.ActiveUser.Union(Dictionary<string, object> values);
/// <summary> Union a given list with a list-valued property, excluding duplicate values. </summary>
/// <param name="key"> Property name </param>
/// <param name="value"> Appending value of type {string|int|double|List} </param>
DevToDev.Analytics.ActiveUser.AppendUserData(string key, object value);
/// <summary> Multiple union of a given lists with a list-valued properties at once </summary>
/// <param name="values"> An associative array of property names and values </param>
DevToDev.Analytics.ActiveUser.AppendUserData(Dictionary<string, object> values);
/**
* Union a given list with a list-valued property, excluding duplicate values.
* @param NSString key - property name
* @param {NSString|NSNumber|NSNull|NSArray|NSDictionary|NSDate|NSURL} value - appending value
*/
[DevToDev.activeUser unionWithKey: (NSString *) key andValue: (id) value];
/**
* Multiple union of a given lists with a list-valued properties at once
* @param NSDictionary values - an associative array of property names and values.
*/
[DevToDev.activeUser unionWithData: (NSDictionary *) values];
/**
* Union a given list with a list-valued property, excluding duplicate values.
* @param key - property name
* @param value - appending value (String|Number|Array)
*/
DevToDev.getActiveUser().UnionUserData(key:String, value:Object);
/**
* Multiple union of a given lists with a list-valued properties at once
* @param values - an associative array of property names and values.
*/
DevToDev.getActiveUser().UnionUserDataMany(data:Dictionary);
Removing of the custom property
Removes a property or a list of properties and their values from the current user's profile.
/**
* Removes property from user data.
*
* ### Usage:
* [DevToDev.activeUser unsetUserDataWithKey: @"Hair color"];
*
* @param NSString key - the name of the property
*/
[DevToDev.activeUser unsetUserDataWithKey: (NSString *) key];
/**
* Removes multiple properties from user data at once.
*
* ### Usage:
* [DevToDev.activeUser unsetUserData: @[ @"Hair color", @"blonde", @"Last payment" ]];
*
* @param NSArray keys - an array of property names.
*/
[DevToDev.activeUser unsetUserData: (NSArray *) keys];
/**
* Removes property from user data.
*
* ### Usage:
* DevToDev.getActivePlayer().unsetUserData("Hair color");
*
* @param String key - the name of the property
*/
DevToDev.getActivePlayer().unsetUserData(String key);
/**
* Removes multiple properties from user data at once.
*
* ### Usage:
* final List<String> unsetData = new ArrayList<String>();
* unsetData.add("Hair color");
* unsetData.add("Last payment");
* DevToDev.getActivePlayer().unsetUserData(unsetData);
*
* @param List keys - an array of property names.
*/
DevToDev.getActivePlayer().unsetUserData(final List<String> keys);
/**
* Removes property from user data.
*
* ### Usage:
* DevToDev.SDK.ActiveUser.UnsetUserData("Hair color");
*
* <param name="key">the name of the property</param>
*/
DevToDev.SDK.ActiveUser.UnsetUserData(string key);
/**
* Removes multiple properties from user data at once.
*
* ### Usage:
* List<string> unsetData = new List<string>();
* unsetData.add("Hair color");
* unsetData.add("Last payment");
* DevToDev.SDK.ActiveUser.UnsetUserData(unsetData);
*
* <param name="keys">an array of property names</param>
*/
DevToDev.SDK.ActiveUser.UnsetUserData(List<string> keys);
/*
* Removes properties from a user data.
*
* ### Usage:
* devtodev.user.remove('Hair color');
*
* // to set multiple properties at once
* devtodev.user.remove(['Hair color', 'blonde', 'Last payment']);
*
* @param {Array|String} prop If a string, this is the name of the property. If an array, this is an array of names.
*/
devtodev.user.remove(prop);
/// <summary> Removes property from user data. </summary>
/// <example> Usage:
///
/// DevToDev.Analytics.ActiveUser.UnsetUserData("Hair color");
///
/// </example>
/// <param name="key"> The name of the property </param>
DevToDev.Analytics.ActiveUser.UnsetUserData(string key);
/// <summary> Removes multiple properties from user data at once. </summary>
/// <example> Usage:
///
/// List<string> unsetData = new List<string>();
/// unsetData.add("Hair color");
/// unsetData.add("Last payment");
/// DevToDev.Analytics.ActiveUser.UnsetUserData(unsetData);
///
/// </example>
/// <param name="keys"> An array of property names </param>
DevToDev.Analytics.ActiveUser.UnsetUserData(List<string> keys);
/**
* Removes property from user data.
*
* ### Usage:
* [DevToDev.activeUser unsetUserDataWithKey: @"Hair color"];
*
* @param NSString key - the name of the property
*/
[DevToDev.activeUser unsetUserDataWithKey: (NSString *) key];
/**
* Removes multiple properties from user data at once.
*
* ### Usage:
* [DevToDev.activeUser unsetUserData: @[ @"Hair color", @"blonde", @"Last payment" ]];
*
* @param NSArray keys - an array of property names.
*/
[DevToDev.activeUser unsetUserData: (NSArray *) keys];
/**
* Removes property from user data.
* ### Usage:
* DevToDev.getActiveUser().UnsetUserData("Hair color");
*
* @param key - the name of the property
*/
DevToDev.getActiveUser().UnsetUserData(key:String);
/**
* Removes multiple properties from user data at once.
* ### Usage:
* var unsetData:Array = new Array();
* unsetData.push("Hair color");
* unsetData.push("Last payment");
* DevToDev.getActiveUser().UnsetUserDataMany(unsetData);
*
* @param keys - an array of property names.
*/
DevToDev.getActiveUser().UnsetUserDataMany(keys:Array);
Blueprint
Code
UPeopleLibrary::UnsetUserData(const TArray<FString>& Attributes);
Clearing of the all custom properties
/**
* Removes all user's custom personal data from devtodev data base.
*/
[DevToDev.activeUser clearUserData];
/**
* Removes all user's custom personal data from devtodev data base.
*/
DevToDev.getActivePlayer().clearUserData();
/**
* Removes all user's custom personal data from devtodev data base.
*/
DevToDev.SDK.ActiveUser.ClearUserData();
/*
* Removes all user's custom personal data from devtodev data base.
*/
devtodev.user.clearUser();
/// <summary> Removes all user's custom personal data from devtodev data base.</summary>
DevToDev.Analytics.ActiveUser.ClearUserData();
/**
* Removes all user's custom personal data from devtodev data base.
*/
[DevToDev.activeUser clearUserData];
/**
* Removes all user's custom personal data from devtodev data base.
*/
DevToDev.getActiveUser().ClearUserData();
Blueprint
Code
UPeopleLibrary::ClearUserData();
Last updated