User profile

User ID

This method is used to initialize the user in applications where you have set calculation by user ID specified by the developer.

You can also use this method when calculating by device ID (by default) to pass in the user ID used on your servers so that you can easily find the user on devtodev.

iOS+macOS (Swift)

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of theDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the setUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the setUserId method.

DTDAnalytics.setUserId(userId: "Custom User ID")

To get the current value of the user ID, use the asynchronous method getDeviceId(_ completionHandler: @escaping (String) -> Void)

DTDAnalytics.getUserId { userId in
  // your code
}

iOS+macOS (Objective-C)

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of theDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the setUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the setUserId method.

[DTDAnalytics userId:@"Custom User ID"];

To get the current value of the user ID, use the asynchronous method (void)deviceIdHandler:( void (^ _Nonnull)(NSString * _Nonnull))completion-Handler;

[DTDAnalytics userIdHandler:^(NSString * _Nonnull userId) {
  // your code
}];

Android (Kotlin)

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of theDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the setUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the setUserId method.

DTDAnalytics.setUserId(userId = "Custom User ID")

To get the current value of the user ID, use the asynchronous method getDeviceId(block: (String) -> Unit)

DTDAnalytics.getUserId { userId ->
  // your code
}

Android (Java)

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of theDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the setUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the setUserId method.

DTDAnalytics.INSTANCE.setUserId("Custom User ID");

To get the current value of the user ID, use the asynchronous method getDeviceId(block: (String) -> Unit)

DTDAnalytics.INSTANCE.getUserId(userID ->
      // your code
      null
);

.NET Native + UWP

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of theDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the SetUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the SetUserId method.

DTDAnalytics.SetUserId(userId: "Custom User ID")

To get the current value of the user ID, use the asynchronous method:

var userId = await DTDAnalytics.GetUserId();

Unity

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of theDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the SetUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the SetUserId method.

DTDAnalytics.SetUserId(userId: "Custom User ID")

To get the current value of the user ID, use the asynchronous method:

DTDAnalytics.GetUserId(id =>
{
  //your code
});

Web

We recommend that you pass this parameter in the initialization configuration (userId property in config object).

Do not pass an empty string ("") to the setUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the setUserId method.

window.devtodev.setUserId("Custom User ID")

To get the current value of the user ID, use the getUserIdmethod

var userId = window.devtodev.getUserId()

Unreal

We recommend that you pass this parameter in the initialization configuration (UserId property of an instance of the FDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the SetUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use method:

Blueprint

Arguments	Type	Description
userId	FString	User ID.

UDTDAnalyticsBPLibrary::SetUserId("Name");

To get the current value of the user ID, use the asynchronous method:

Blueprint

Arguments	Type	Description
onResult	FAnalyticsDynamicGetterStringDelegate FDTDGetterStringDelegate	Callback

auto onResult = new FDTDGetterStringDelegate();
onResult->BindLambda([](const FString& value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::GetUserId(*onResult);

Godot

We recommend that you pass this parameter in the initialization configuration (userId property of an instance of the GDDTDAnalyticsConfiguration class).

Do not pass an empty string ("") to the setUserID method as the user ID. Assigning an empty string is a command to assign a default value to the user ID (it is equal to the current device ID). In applications with calculation by user ID, this can lead to unnecessary registrations.

To set a new value as the user ID, use the SetUserId method.

DTDAnalytics.SetUserId("Custom User ID")

To get the current value of the user ID, use the asynchronous method DTDAnalytics.GetUserId(onResult: Callable)

DTDAnalytics.GetUserId(getUserIdHandler)

func getUserIdHandler(userId: String): 
  print(userId)

In order to track a user on several devices you can switch the identification method to identification by Custom User Id. This switch can be done only by devtodev – you just need to write a request to the support (use the Contact Us form), specifying the space name and project name. You must set the user IDs for all users before changing the identification method.

Please note: changing the idetification method is irreversible and you will not be able to switch back to the device identifiers in the future!

Replace

This method is used in very rare cases. It is applicable in the case when the calculation of users in the project is carried out by the user ID specified by the developer. In this case, the application can change this identifier. For example, calculation in the application is carried out by user emails and in the application, it is possible to change this email to another one. At the time of replacement, you need to call this method, specifying the user's previous email and the one with which it was replaced.

iOS+macOS (Swift)

DTDAnalytics.replace(fromUserId: "Old user id", toUserId: "New user id")

iOS+macOS (Objective-C)

[DTDAnalytics replaceFromUserId:@"Old user id" toUserId:@"New user id"];

Android (Kotlin)

DTDAnalytics.replaceUserId(
    fromUserId = "Old user id", 
    toUserId = "New user id"
)

Android (Java)

DTDAnalytics.INSTANCE.replaceUserId("Old user id", "New user id");

.NET Native + UWP

DTDAnalytics.Replace(fromUserId: "Old user id", toUserId: "New user id");

Unity

DTDAnalytics.Replace(fromUserId: "Old user id", toUserId: "New user id");

Web

window.devtodev.replace( "Old user id", "New user id")

Unreal

Blueprint

Arguments	Type	Description
fromUserId	FString	From user ID
toUserId	FString	To user ID

UDTDAnalyticsBPLibrary::ReplaceUserId("UserIdBefore", "UserIdAfter");

Godot

DTDAnalytics.ReplaceUserId("Old user id", "New user id")

Do not use this method to re-login as a different user! The setUserId method is used for relogging.

Current user level

This method is used in cross-platform and data synchronized applications. The method is required to update user level data.

iOS+macOS (Swift)

To set the current value to the user level, use setCurrentLevel(currentLevel: Int) method:

DTDAnalytics.setCurrentLevel(value: 2)

We recommend that you use the setCurrentLevel method immediately after using the setUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the setCurrentLevel method when the user reaches a new level. In this case, you must use the levelUp method.

To get the user-level value stored by the SDK, use getCurrentLevel(completionHandler: @escaping (Int) -> Void) method

DTDAnalytics.getCurrentLevel { level in
  // your code
}

iOS+macOS (Objective-C)

To set the current value to the user level, use (void)currentLevel:(NSInteger)currentLevel; method:

[DTDAnalytics currentLevel:2];

We recommend that you use the setCurrentLevel method immediately after using the setUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the setCurrentLevel method when the user reaches a new level. In this case, you must use the levelUp method.

To get the user-level value stored by the SDK, use (void)currentLevelHandler:( void (^ _Nonnull)(NSInteger))completionHandler; method

[DTDAnalytics currentLevelHandler:^(NSInteger level) {
  // your code
}];

Android (Kotlin)

To set the current value to the user level, use method:

DTDAnalytics.setCurrentLevel(currentLevel = 2)

We recommend that you use the setCurrentLevel method immediately after using the setUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the setCurrentLevel method when the user reaches a new level. In this case, you must use the levelUp method.

To get the user-level value stored by the SDK, use getCurrentLevel(completionHandler: @escaping (Int) -> Void) method

DTDAnalytics.getCurrentLevel { level ->
  // your code
}

Android (Java)

To set the current value to the user level, use method:

DTDAnalytics.INSTANCE.setCurrentLevel(2);

We recommend that you use the setCurrentLevel method immediately after using the setUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the setCurrentLevel method when the user reaches a new level. In this case, you must use the levelUp method.

To get the user-level value stored by the SDK, use getCurrentLevel(completionHandler: @escaping (Int) -> Void) method

DTDAnalytics.INSTANCE.getCurrentLevel ( currentLevel ->
       // your code 
       null
);

.NET Native + UWP

To set the current value to the user level, use method:

DTDAnalytics.SetCurrentLevel(level: 3);

We recommend that you use the SetCurrentLevel method immediately after using the SetUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the SetCurrentLevel method when the user reaches a new level. In this case, you must use the LevelUp method.

To get the user-level value stored by the SDK, use GetCurrentLevel method:

var currentLevel = await DTDAnalytics.GetCurrentLevel();

Unity

To set the current value to the user level, use method:

DTDAnalytics.SetCurrentLevel(level: 3);

We recommend that you use the SetCurrentLevel method immediately after using the SetUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the SetCurrentLevel method when the user reaches a new level. In this case, you must use the LevelUp method.

To get the user-level value stored by the SDK, use GetCurrentLevel method:

DTDAnalytics.GetCurrentLevel(level =>
{
  //your code
});

Web

To set the current value to the user level, use method:

window.devtodev.setCurrentLevel(2)

We recommend that you use the setCurrentLevel method immediately after using the setUserID method or specify the current user level in the initialization configuration (the level property of an instance of the DTDAnalyticsConfiguration).

Do not use the setCurrentLevel method when the user reaches a new level. In this case, you must use the levelUp method.

To get the user-level value stored by the SDK, use getCurrentLevel method.

var currentLevel = window.devtodev.getCurrentLevel()

Unreal

To set the current value to the user level, use method:

Blueprint

Arguments	Type	Description
level	int32	Current level.

UDTDAnalyticsBPLibrary::SetCurrentLevel(7);

We recommend that you use the SetCurrentLevel method immediately after using the SetUserID method or specify the current user level in the initialization configuration (the level property of an instance of the EDTDAnalyticsConfiguration).

Do not use the SetCurrentLevel method when the user reaches a new level. In this case, you must use the LevelUp method.

To get the user-level value stored by the SDK, use method:

Blueprint

Arguments	Type	Description
onResult	FAnalyticsDynamicGetterIntDelegate FDTDGetterIntDelegate	Callback

auto onResult = new FDTDGetterIntDelegate();
onResult->BindLambda([](int32 value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::GetCurrentLevel(*onResult);

Godot

To set the current value to the user level, use SetCurrentLevel(level: int) method:

DTDAnalytics.SetCurrentLevel(2)

We recommend that you use the SetCurrentLevel method immediately after using the SetUserID method or specify the current user level in the initialization configuration (the level property of an instance of the GDDTDAnalyticsConfiguration).

Do not use the SetCurrentLevel method when the user reaches a new level. In this case, you must use the LevelUp method.

To get the user-level value stored by the SDK, use GetCurrentLevel(onResult: Callable) method

DTDAnalytics.GetCurrentLevel(getCurrentLevelHandler)

func getCurrentLevelHandler(level: int):
    print("result is: " + str(level))

Cheater

If you have your own methods for detecting cheaters in the application, you can tag such users. Actions taken by these users will not be counted in statistics.

If you need to exclude transactions from such users from statistics, go to Users & Segments section in devtodev interface and mark the user manually. When you mark the user in devtodev interface, the system removes their transactions for the last 7 days the reports and recalculates the metrics.

iOS+macOS (Swift)

DTDUserCard.setCheater(cheater: true)

iOS+macOS (Objective-C)

[DTDUserCard setCheater:true];

Android (Kotlin)

DTDUserCard.setCheater(cheater = true)

Android (Java)

DTDUserCard.INSTANCE.setCheater(true);

.NET Native + UWP

DTDUserCard.SetCheater(cheater: true);

Unity

DTDUserCard.SetCheater(cheater: true);

Web

window.devtodev.user.setCheater(true)

Unreal

Blueprint

Arguments	Type	Description
cheater	bool	Cheater flag

UDTDUserCardBPLibrary::SetCheater(true);

Godot

DTDUserCard.SetCheater(true)

Tester

Use this method to tag a user as a tester. Events performed by testers will not be included in statistics.

If you need to exclude transactions from such users from statistics, go to Users & Segments section in devtodev interface and mark the user manually. When you mark the user in devtodev interface, the system removes their transactions for the last 7 days the reports and recalculates the metrics.

iOS+macOS (Swift)

DTDUserCard.setTester(tester: true)

iOS+macOS (Objective-C)

[DTDUserCard setTester:true];

Android (Kotlin)

DTDUserCard.setTester(tester = true)

Android (Java)

DTDUserCard.INSTANCE.setTester(true);

.NET Native + UWP

DTDUserCard.SetTester(tester: true);

Unity

DTDUserCard.SetTester(tester: true);

Web

window.devtodev.user.setTester(true)

Unreal

Blueprint

Arguments	Type	Description
tester	bool	Tester flag

UDTDUserCardBPLibrary::SetTester(true);

Godot

DTDUserCard.SetTester(true)

Reserved user properties

Attention! These properties have been removed since the devtodev SDK versions: iOS & macOS 2.4.0, Android 2.5.0, Unity SDK 3.8.0, Godot 1.0.0, Web 2.1

We strongly recommend not to use these properties because they refer to personal data.

iOS + macOS

Attention! We strongly discourage the storage of personal user data! If you plan to pass this data, be sure to indicate this in the ‘Nutrition label’ when submitting the application to the App Store review.

Property	Getter	Setter
Name	setName(name: String)	getName(completionHandler: @escaping (String?) -> Void)
Email	setEmail(email: String)	getEmail(completionHandler: @escaping (String?) -> Void)
Phone	setPhone(phone: String)	getPhone(completionHandler: @escaping (String?) -> Void)
Photo	setPhoto(photo: String)	getPhoto(completionHandler: @escaping (String?) -> Void)
Gender	setGender(gender: DTDGender)	getGender(completionHandler: @escaping (DTDGender) -> Void)
Age	setAge(age: Int)	getAge(completionHandler: @escaping (Int) -> Void

iOS+macOS (Objective-C)

Attention! We strongly discourage the storage of personal user data! If you plan to pass this data, be sure to indicate this in the ‘Nutrition label’ when submitting the application to the App Store review.

Property	Setter	Getter
Age	[DTDUserCard setAge:(NSInteger)];	[DTDUserCard getAgeHandler:^(NSInteger age) { }]
Email	[DTDUserCard setEmail:(NSString * _Nonnull)];	[DTDUserCard getEmailHandler:^(NSString * email) { }];
Gender	[DTDUserCard setGender:(enum Gender)];	[DTDUserCard getGenderHandler:^(enum Gender gender) { }];
Name	[DTDUserCard setName:(NSString * _Nonnull)];	[DTDUserCard getNameHandler:^(NSString * name) { }];
Phone	[DTDUserCard setPhone:(NSString * _Nonnull)];	[DTDUserCard getPhoneHandler:^(NSString * phone) { }];
Photo	[DTDUserCard setPhoto:(NSString * _Nonnull)];	[DTDUserCard getPhotoHandler:^(NSString * photo) { }];

Android (Kotlin)

Property	Getter	Setter
Name	setName(name: String)	getName(handler: (String) -> Unit)
Email	setEmail(email: String)	getEmail(handler: (String) -> Unit)
Phone	setPhone(phone: String)	getPhone(handler: (String) -> Unit)
Photo	setPhoto(photo: String)	getPhoto(handler: (String) -> Unit)
Gender	setGender(gender: DTDGender)	getGender(handler: (DTDGender) -> Void)
Age	setAge(age: Int)	getAge(handler: (String) -> Unit)

Android (Java)

Property	Getter	Setter
Name	setName(name: String)	getName(handler: (String) -> Unit)
Email	setEmail(email: String)	getEmail(handler: (String) -> Unit)
Phone	setPhone(phone: String)	getPhone(handler: (String) -> Unit)
Photo	setPhoto(photo: String)	getPhoto(handler: (String) -> Unit)
Gender	setGender(gender: DTDGender)	getGender(handler: (DTDGender) -> Void)
Age	setAge(age: Int)	getAge(handler: (String) -> Unit)

.NET Native + UWP

Property	Getter	Setter
Name	SetName(name: string)	Task<string> GetName();
Email	SetEmail(email: string)	Task<string> GetEmail()
Phone	SetPhone(phone: string)	Task<string> GetPhone()
Photo	SetPhoto(photo: string)	Task<string> GetPhoto()
Gender	SetGender(gender: DTDGender)	Task<DTDGender> GetGender()
Age	SetAge(age: long)	Task<long> GetAge()

Unity

Attention! We strongly discourage the storage of personal user data! If you plan to pass this data, be sure to indicate this in the ‘Nutrition label’ when submitting the application to the App Store review.

Property	Getter	Setter
Name	SetName(name: string)	GetName(Action<string> onGetName)
Email	SetEmail(email: string)	GetEmail(Action<string> onGetEmail)
Phone	SetPhone(phone: string)	GetPhone(Action<string> onGetPhone)
Photo	SetPhoto(photo: string)	GetPhoto(Action<string> onGetPhoto)
Gender	SetGender(gender: DTDGender)	GetGender(Action<DTDGender> onGetGender)
Age	SetAge(age: long)	GetAge(Action<string> onGetAge)

Web

Property	Getter	Setter	Type
Name	getName()	setName("John Doe")	String
Email	getEmail()	setEmail("[e-mail]")	String
Phone	getPhone()	setPhone("[phone]")	String
Photo	getPhoto()	setPhoto("https://domain.com/photo.jpg")	String
Gender	getGender()	setGender(gender)
Age	getAge()	setAge(age)	Int

Unreal

Attention! We strongly discourage the storage of personal user data! If you plan to pass this data, be sure to indicate this in the ‘Nutrition label’ when submitting the application to the App Store review.

Property	Setter	Getter
Name	SetName(name: FString)	GetName(delegate: FUserCardDynamicGetterStringDelegate) GetName(delegate: FDTDGetterStringDelegate)
Email	SetEmail(email: FString)	GetEmail(delegate: FUserCardDynamicGetterStringDelegate) GetEmail(delegate: FDTDGetterStringDelegate)
Phone	SetPhone(phone: FString)	GetPhone(delegate: FUserCardDynamicGetterStringDelegate) GetPhone(delegate: FDTDGetterStringDelegate)
Photo	SetPhoto(photo: FString)	GetPhoto(delegate: FUserCardDynamicGetterStringDelegate) GetPhoto(delegate: FDTDGetterStringDelegate)
Gender	SetGender(gender: EDTDGender)	GetGender(delegate: FUserCardDynamicGetterGenderDelegate) GetGender(delegate: FDTDGetterGenderDelegate)
Age	SetAge(age: int64)	GetAge(delegate: FUserCardDynamicGetterLongDelegate) GetAge(delegate: FDTDGetterLongDelegate)

Example:

Blueprint

UDTDUserCardBPLibrary::SetEmail("Email");

Blueprint

auto onResult = new FDTDGetterStringDelegate();
onResult->BindLambda([](const FString& value)
{
	// Your code...
});
UDTDUserCardBPLibrary::GetEmail(*onResult);

Custom user property

Each devtodev project can have up to 30 custom user properties. User custom property values can be a number, a string (up to 500 symbols), or a boolean value.

Attention! We strongly recommend that you do not use these properties to transfer and store data that fits the definition of personal data!

iOS+macOS (Swift)

This is how you can set properties on the current user profile:

DTDUserCard.set(key: "key for string value", value: "string value")
DTDUserCard.set(key: "key for int value", value: 10)
DTDUserCard.set(key: "key for double value", value: 12.5)
DTDUserCard.set(key: "key for bool value", value: true)

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

getValue(key: String, _completionHandler: @escaping (Any) -> Void)

DTDUserCard.getValue(key: "key for value") { value in
  // your code
}

When using the getValue method, note that the Any return type will need to be cast to the data type you want.

iOS+macOS (Objective-C)

This is how you can set properties on the current user profile:

[DTDUserCard setString:@"key for string value" value:@"string value"];
[DTDUserCard setInt:@"key for int value" value:10];
[DTDUserCard setDouble:@"key for double value" value:12.5];
[DTDUserCard setBool:@"key for bool value" value:true];

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

(void)getValueWithKey:(NSString * _Nonnull)key :(void (^ _Nonnull)(id _Nullable))completionHandler;

[DTDUserCard getValueWithKey:@"key for value" :^(id object) {
  // your code
}];

When using the getValue method, note that the Anyreturn type will need to be cast to the data type you want.

Android (Kotlin)

This is how you can set properties on the current user profile:

DTDUserCard.set(key = "key for string value", value = "string value")
DTDUserCard.set(key = "key for int value", value = 10)
DTDUserCard.set(key = "key for double value", value = 12.5)
DTDUserCard.set(key = "key for bool value", value = true)

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

getValue(key: String, handler: (Any?) -> Unit)

DTDUserCard.getValue(key = "key for value") { value ->
  // your code
}

When using the getValue method, note that the Anyreturn type will need to be cast to the data type you want.

Android (Java)

This is how you can set properties on the current user profile:

DTDUserCard.INSTANCE.set("key for string value", "string value");
DTDUserCard.INSTANCE.set("key for int value", 10);
DTDUserCard.INSTANCE.set("key for double value", 12.5);
DTDUserCard.INSTANCE.set("key for bool value", true);

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

getValue(key: String, handler: (Any?) -> Unit)

DTDUserCard.INSTANCE.getValue("key for value", value ->
       // your code
       null
);j

When using the getValue method, note that the Anyreturn type will need to be cast to the data type you want.

.NET Native + UWP

This is how you can set properties on the current user profile:

DTDUserCard.Set(key: "key for string value", value: "string value");
DTDUserCard.Set(key: "key for int value", value: 10);
DTDUserCard.Set(key: "key for double value", value: 12.5);
DTDUserCard.Set(key: "key for bool value", value: true);

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

var value = await DTDUserCard.Get(key: "key for value");
switch (value)
{
    case bool boolValue:
        break;
    case long longValue:
        break;
    case double doubleValue:
        break;
    case string stringValue:
        break;
}

When using the Get method, note that the object return type will need to be cast to the data type you want.

Unity

This is how you can set properties on the current user profile:

DTDUserCard.Set(key: "key for string value", value: "string value");
DTDUserCard.Set(key: "key for int value", value: 10);
DTDUserCard.Set(key: "key for double value", value: 12.5);
DTDUserCard.Set(key: "key for bool value", value: true);

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

DTDUserCard.GetValue("key", value =>
{
    switch (value)
    {
    case bool boolValue:
        break;
    case long longValue:
        break;
    case double doubleValue:
        break;
    case string stringValue:
        break;
    }             
})
DTDUserCard.Get(key: "key for value");

When using the Get method, note that the object return type will need to be cast to the data type you want.

Web

This is how you can set properties on the current user profile:

window.devtodev.user.set("key for string value",  "string value")
window.devtodev.user.set("key for int value", 10)
window.devtodev.user.set("key for double value", 12.5)
window.devtodev.user.set("key for bool value", true)

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use the method:

window.devtodev.user.getValue("key for value") 

Unreal

This is how you can set properties on the current user profile:

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
value	bool	Parameter value.

UDTDUserCardBPLibrary::SetBool("BoolKey", true);

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
value	float	Parameter value.

UUDTDUserCardBPLibrary::SetFloat("FloatKey", 3.333);

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
value	int64	Parameter value.

UDTDUserCardBPLibrary::SetLong("LongKey", 1000);

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
value	FString	Parameter value.

UDTDUserCardBPLibrary::SetString("StringKey", "StringValue");

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current value stored in the user profile on the SDK, you need to use methods:

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
onResult	FUserCardDynamicGetterOptionalBoolDelegate FDTDGetterOptionalBoolWithKeyDelegate	Callback.

FString key = FString(TEXT("Key"));
auto onResult = new FDTDGetterOptionalBoolWithKeyDelegate();
onResult->BindLambda([](bool success, const FString& key, bool value)
{
	// Your code...
});
UDTDUserCardBPLibrary::TryGetBool(key, *onResult);

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
onResult	FUserCardDynamicGetterOptionalFloatDelegate FDTDGetterOptionalFloatWithKeyDelegate	Callback.

FString key = FString(TEXT("Key"));
auto onResult = new FDTDGetterOptionalFloatWithKeyDelegate();
onResult->BindLambda([](bool success, const FString& key, float value)
{
	// Your code...
});
UDTDUserCardBPLibrary::TryGetFloat(key, *onResult);

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
onResult	FUserCardDynamicGetterOptionalLongDelegate FDTDGetterOptionalLongWithKeyDelegate	Callback.

FString key = FString(TEXT("Key"));
auto onResult = new FDTDGetterOptionalIntWithKeyDelegate();
onResult->BindLambda([](bool success, const FString& key, int64 value)
{
	// Your code...
});
UDTDUserCardBPLibrary::TryGetLong(key, *onResult);

Blueprint

Arguments	Type	Description
key	FString	Parameter key.
onResult	FUserCardDynamicGetterOptionalStringDelegate FDTDGetterOptionalStringWithKeyDelegate	Callback.

FString key = FString(TEXT("Key"));
auto onResult = new FDTDGetterOptionalStringWithKeyDelegate();
onResult->BindLambda([](bool success, const FString& key, const FString& value)
{
	// Your code...
});
UDTDUserCardBPLibrary::TryGetString(key, *onResult);

Godot

This is how you can set properties on the current user profile:

DTDUserCard.SetString("key for string value", "string value")
DTDUserCard.SetInt("key for int value", 10)
DTDUserCard.SetFloat("key for double value", 12.5)
DTDUserCard.SetBool("key for bool value", true)

It is important to remember that the key for custom user properties has a length limit. If the limit is exceeded (from 1 to 64 characters), the key will be truncated to the maximum allowed length

To get the current values stored in the user profile on the SDK, you need to use the methods:

TryGetBool(key: String, callback: Callable)

TryGetFloat(key: String, callback: Callable)

TryGetInt(key: String, callback: Callable)

TryGetString(key: String, callback: Callable

DTDUserCard.TryGetInt("intKey", getIntHandler)
DTDUserCard.TryGetString("intKey", getStringHandler)
DTDUserCard.TryGetFloat("intKey", getFloatHandler)
DTDUserCard.TryGetBool("intKey", getBoolHandler)

func getIntHandler(isValid: bool, value: int):
	print("isValid = " + str(isValid) + " integer = " + str(value))

func getStringHandler(isValid: bool, value: String):
	print("isValid = " + str(isValid) + " string = " + value)
	
func getFloatHandler(isValid: bool, value: float):
	print("isValid = " + str(isValid) + " float = " + str(value))
	
func getBoolHandler(isValid: bool, value: bool):
	print("isValid = " + str(isValid) + " bool = " + str(value))

The isValid parameter is responsible for the presence of the requested key in the user card.

Unset user property

It removes a property or a list of properties and their values from the current user profile.

iOS+macOS (Swift)

DTDUserCard.unset(property: "key for string value")
DTDUserCard.unset(properties: ["key for string value", 
                               "key for int value"])

iOS+macOS (Objective-C)

[DTDUserCard unsetProperty:@"key for string value"];
[DTDUserCard unset:@[@"key for string value",
                     @"key for int value"]];

Android (Kotlin)

DTDUserCard.unset(property = "key for string value")
DTDUserCard.unset(property = listOf("key for string value", "key for int value"))

Android (Java)

DTDUserCard.INSTANCE.unset( "key for string value");

ArrayList<String> properties = new ArrayList<>();
properties.add("key for string value");
properties.add("key for int value");
DTDUserCard.INSTANCE.unset(properties);

.NET Native + UWP

DTDUserCard.Unset(keys: "key 1");
DTDUserCard.Unset(keys: "key 1", "key 2", "key 3");

UNI

DTDUserCard.Unset(keys: "key 1");
DTDUserCard.Unset(keys: "key 1", "key 2", "key 3");

Web

window.devtodev.user.unset("key for string value")
window.devtodev.user.unset(["key for string value", "key for int value"])

Unreal

Blueprint

Arguments	Type	Description
key	FString	Parameter key.

UDTDUserCardBPLibrary::Unset("Key");

Blueprint

Arguments	Type	Description
keys	TArray<FString>	Parameter keys.

TArray<FString> keys;
keys.Add("Key1");
keys.Add("Key2");
UDTDUserCardBPLibrary::UnsetArray(keys);

Godot

DTDUserCard.Unset("intKey")

var arrayOfKeys = ["floatKey", "boolKey"]
DTDUserCard.UnsetArray(arrayOfKeys)

Unset all user properties

To remove all properties from the user card, use:

iOS+macOS (Swift)

DTDUserCard.clearUser()

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the setCheater method.

iOS+macOS (Objective-C)

[DTDUserCard clearUser];

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the setCheater method.

Android (Kotlin)

DTDUserCard.clearUser()

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the setCheater method.

Android (Java)

DTDUserCard.INSTANCE.clearUser();

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the setCheater method.

.NET Native + UWP

DTDUserCard.ClearUser();

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the SetCheater method.

Unity

DTDUserCard.ClearUser();

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the SetCheater method.

Web

window.devtodev.user.clearUser()

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the setCheater method.

Unreal

Blueprint

UDTDUserCardBPLibrary::ClearUser();

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the SetCheater method.

Godot

DTDUserCard.ClearUser()

Keep in mind that the cheater mark is not cleared from the user card; you can only uncheck the mark manually using the setCheater method.