Static Public Member Functions
static void	UpdateUserInfo (UserInfoUpdate info, Action< UserInfo > onSuccess, Action< Error > onError)
	Updates the specified user’s information. Changes are made on the user data storage side. More...

static void	SearchUsers (string nickname, int offset, int limit, Action< FoundUsers > onSuccess, Action< Error > onError)
	Searches users by the nickname parameter and gets a list of them. Search can be performed instantly when the user starts entering the search parameter. NOTE: User can search only 1 time per second. More...

static void	GetPublicInfo (string userId, Action< UserPublicInfo > onSuccess, Action< Error > onError)
	Returns specified user public profile information. More...

static void	GetUserPhoneNumber (Action< UserPhoneNumber > onSuccess, Action< Error > onError)
	Returns user phone number that is used for two-factor authentication. More...

static void	UpdateUserPhoneNumber (string phoneNumber, Action onSuccess, Action< Error > onError)
	Changes the user’s phone number that is used for two-factor authentication. Changes are made on the user data storage side (server-side). More...

static void	DeleteUserPhoneNumber (string phoneNumber, Action onSuccess, Action< Error > onError)
	Deletes the user’s phone number that is used for two-factor authentication. Changes are made on the user data storage side (server side). More...

static void	UploadUserPicture (byte[] pictureData, string boundary, Action< string > onSuccess, Action< Error > onError)
	Changes the user’s avatar. Changes are made on the user data storage side (server side). More...

static void	DeleteUserPicture (Action onSuccess, Action< Error > onError)
	Deletes the user’s avatar. Changes are made on the user data storage side (server side). More...

static void	CheckUserAge (string dateOfBirth, Action< CheckUserAgeResult > onSuccess, Action< Error > onError)
	Checks user age for a particular region. The age requirements depend on the region. Service determines the user location by the IP address. More...

static void	GetUserEmail (Action< UserEmail > onSuccess, Action< Error > onError)
	Returns the user’s email. More...

static void	RequestLinkingCode (Action< LinkingCode > onSuccess, Action< Error > onError)
	Creates the code for linking the platform account to the existing main account when the user logs in to the game via a gaming console. The call is used with Link accounts by code request. More...

static void	LinkConsoleAccount (string userId, string platform, string confirmationCode, Action onSuccess, Action< Error > onError)
	This method is used for authenticating users in Xsolla Login, who play on the consoles and other platforms where Xsolla Login isn't used. You must implement it on the your server side. Integration flow on the server side: Generate server JWT Connect OAuth 2.0 server client Follow the instructions to connect the client and cope copy the Client ID and Secret key. Implement method: with `application/x-www-form-urlencoded` payload parameters: client_id=YOUR_CLIENT_ID client_secret=YOUR_CLIENT_SECRET grant_type=client_credentials Implement APIs for account linking with: Headers `Content-Type: application/json` and `X-SERVER-AUTHORIZATION: YourGeneratedJwt` Body See documentation. More...

static void	GetUserAttributes (UserAttributeType attributeType, List< string > keys, string userId, Action< UserAttributes > onSuccess, Action< Error > onError)
	Returns a list of particular user’s attributes with their values and descriptions. Returns only user-editable attributes. More...

static void	UpdateUserAttributes (List< UserAttribute > attributes, Action onSuccess, Action< Error > onError)
	Updates the values of user attributes with the specified IDs. The method can be used to create or remove attributes. Changes are made on the user data storage side (server side). More...

static void	RemoveUserAttributes (List< string > removingKeys, Action onSuccess, Action< Error > onError)
	Removes user attributes with the specified IDs. Changes are made on the user data storage side (server side). More...

static void	AddUsernameEmailAuthToAccount (string username, string password, string email, Action< AddUsernameAndEmailResult > onSuccess, Action< Error > onError, string redirectUri=null, int? promoEmailAgreement=null)
	Adds a username, email address, and password, that can be used for authentication, to the current account. More...

static void	GetUserDevices (Action< UserDevicesInfo > onSuccess, Action< Error > onError)
	Gets a list of user's devices. More...

static void	LinkDeviceToAccount (Action onSuccess, Action< Error > onError, DeviceInfo deviceInfo=null)
	Links the specified device to the current user account. More...

static void	UnlinkDeviceFromAccount (int deviceId, Action onSuccess, Action< Error > onError)
	Unlinks the specified device from the current user account. More...

static void	GetUserSocialFriends (Action< UserSocialFriends > onSuccess, Action< Error > onError, SocialProvider platform=SocialProvider.None, int offset=0, int limit=500, bool withXlUid=false)
	Gets a list of user’s friends from a social provider. More...

static void	UpdateUserSocialFriends (Action onSuccess, Action< Error > onError, SocialProvider platform=SocialProvider.None)
	Begins data processing to update a list of user’s friends from a social provider. Note that there may be a delay in data processing because of the Xsolla Login server or provider server high loads. More...

static void	GetUserFriends (FriendsSearchType type, Action< UserFriends > onSuccess, Action< Error > onError, FriendsSearchSort sortBy=FriendsSearchSort.ByNickname, FriendsSearchOrder sortOrder=FriendsSearchOrder.Asc, int limit=20, int offset=0)
	Gets a list of users added as friends of the authenticated user. More...

static void	UpdateUserFriends (FriendAction action, string user, Action onSuccess, Action< Error > onError)
	Modifies relationships with the specified user. More...

static void	LinkSocialProvider (SocialProvider providerName, Action< LinkSocialProviderLink > onSuccess, Action< Error > onError, string redirectUri=null)
	Links a social network that can be used for authentication to the current account. More...

static void	UnlinkSocialProvider (SocialProvider providerName, Action onSuccess, Action< Error > onError)
	Unlinks social network that can be used for authentication from the current user account. More...

static void	GetLinkedSocialProviders (Action< LinkedSocialNetworks > onSuccess, Action< Error > onError)
	Returns the list of social networks linked to the user account. More...

Member Function Documentation

◆ AddUsernameEmailAuthToAccount()

static void Xsolla.UserAccount.XsollaUserAccount.AddUsernameEmailAuthToAccount	(	string	username,
		string	password,
		string	email,
		Action< AddUsernameAndEmailResult >	onSuccess,
		Action< Error >	onError,
		string	redirectUri = `null`,
		int?	promoEmailAgreement = `null`
	)

inlinestatic

Adds a username, email address, and password, that can be used for authentication, to the current account.

More about the use cases.

Parameters

username	Username.
password	User password.
email	User email.
onSuccess	Called after successful email and password linking.
onError	Called after the request resulted with an error.
redirectUri	URI to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the OAuth 2.0 redirect URIs specified in Publisher Account. Required if there are several URIs.
promoEmailAgreement	Whether the user gave consent to receive the newsletters.

◆ CheckUserAge()

static void Xsolla.UserAccount.XsollaUserAccount.CheckUserAge	(	string	dateOfBirth,
		Action< CheckUserAgeResult >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Checks user age for a particular region. The age requirements depend on the region. Service determines the user location by the IP address.

More about the use cases.

Parameters

dateOfBirth	User's birth date in the `YYYY-MM-DD` format.
onSuccess	Called after successful check of the user age.
onError	Called after the request resulted with an error.

◆ DeleteUserPhoneNumber()

static void Xsolla.UserAccount.XsollaUserAccount.DeleteUserPhoneNumber	(	string	phoneNumber,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Deletes the user’s phone number that is used for two-factor authentication. Changes are made on the user data storage side (server side).

More about the use cases.

Parameters

phoneNumber	User phone number for removal.
onSuccess	Called after the user phone number was successfully removed.
onError	Called after the request resulted with an error.

See also: GetUserPhoneNumber, UpdateUserPhoneNumber

◆ DeleteUserPicture()

static void Xsolla.UserAccount.XsollaUserAccount.DeleteUserPicture	(	Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Deletes the user’s avatar. Changes are made on the user data storage side (server side).

More about the use cases.

Parameters

onSuccess	Called after user profile picture was successfully removed.
onError	Called after the request resulted with an error.

See also: UploadUserPicture

◆ GetLinkedSocialProviders()

static void Xsolla.UserAccount.XsollaUserAccount.GetLinkedSocialProviders	(	Action< LinkedSocialNetworks >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Returns the list of social networks linked to the user account.

Parameters

onSuccess	Called after the list of linked social networks was successfully received.
onError	Called after the request resulted with an error.

◆ GetPublicInfo()

static void Xsolla.UserAccount.XsollaUserAccount.GetPublicInfo	(	string	userId,
		Action< UserPublicInfo >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Returns specified user public profile information.

Parameters

userId	User identifier of public profile information to be received.
onSuccess	Called after user profile data was successfully received.
onError	Called after the request resulted with an error.

◆ GetUserAttributes()

static void Xsolla.UserAccount.XsollaUserAccount.GetUserAttributes	(	UserAttributeType	attributeType,
		List< string >	keys,
		string	userId,
		Action< UserAttributes >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Returns a list of particular user’s attributes with their values and descriptions. Returns only user-editable attributes.

More about the use cases.

Parameters

attributeType	Type of attributes to get. Can be `Readonly` or `Custom`.
keys	List of attributes’ keys which you want to get. If not specified, the method returns all user’s attributes.
userId	Identifier of a user whose public attributes should be requested. If not specified, the method returns attributes for the current user.
onSuccess	Called after user attributes were successfully received.
onError	Called after the request resulted with an error.

See also: UpdateUserAttributes, RemoveUserAttributes

◆ GetUserDevices()

static void Xsolla.UserAccount.XsollaUserAccount.GetUserDevices	(	Action< UserDevicesInfo >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Gets a list of user's devices.

More about the use cases.

Parameters

onSuccess	Called after users devices data was successfully received.
onError	Called after the request resulted with an error.

◆ GetUserEmail()

static void Xsolla.UserAccount.XsollaUserAccount.GetUserEmail	(	Action< UserEmail >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Returns the user’s email.

More about the use cases.

Parameters

onSuccess	Called after user email was successfully received.
onError	Called after the request resulted with an error.

◆ GetUserFriends()

static void Xsolla.UserAccount.XsollaUserAccount.GetUserFriends	(	FriendsSearchType	type,
		Action< UserFriends >	onSuccess,
		Action< Error >	onError,
		FriendsSearchSort	sortBy = `FriendsSearchSort.ByNickname`,
		FriendsSearchOrder	sortOrder = `FriendsSearchOrder.Asc`,
		int	limit = `20`,
		int	offset = `0`
	)

inlinestatic

Gets a list of users added as friends of the authenticated user.

Parameters

type	Friends type.
onSuccess	Called after user friends data was successfully received.
onError	Called after the request resulted with an error.
sortBy	Condition for sorting the users.
sortOrder	Condition for sorting the list of users.
offset	Parameter that is used for API pagination.
limit	Maximum number of users that are returned at a time. Default: 20.

◆ GetUserPhoneNumber()

static void Xsolla.UserAccount.XsollaUserAccount.GetUserPhoneNumber	(	Action< UserPhoneNumber >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Returns user phone number that is used for two-factor authentication.

More about the use cases.

Parameters

onSuccess	Called after user phone number was successfully received.
onError	Called after the request resulted with an error.

See also: UpdateUserPhoneNumber, DeleteUserPhoneNumber

◆ GetUserSocialFriends()

static void Xsolla.UserAccount.XsollaUserAccount.GetUserSocialFriends	(	Action< UserSocialFriends >	onSuccess,
		Action< Error >	onError,
		SocialProvider	platform = `SocialProvider.None`,
		int	offset = `0`,
		int	limit = `500`,
		bool	withXlUid = `false`
	)

inlinestatic

Gets a list of user’s friends from a social provider.

Parameters

onSuccess	Called after user friends data was successfully received.
onError	Called after the request resulted with an error.
platform	Name of a social network. Provider must be connected to Login in Publisher Account. Can be `amazon`, `apple`, `baidu`, `battlenet`, `discord`, `facebook`, `github`, `google`, `kakao`, `linkedin`, `mailru`, `microsoft`, `msn`, `naver`, `ok`, `paypal`, `psn`, `qq`, `reddit`, `steam`, `twitch`, `twitter`, `vimeo`, `vk`, `wechat`, `weibo`, `yahoo`, `yandex`, `youtube`, or `xbox`.
offset	Number of the elements from which the list is generated.
limit	Maximum number of friends that are returned at a time.
withXlUid	Shows whether the social friends are from your game.

◆ LinkConsoleAccount()

static void Xsolla.UserAccount.XsollaUserAccount.LinkConsoleAccount	(	string	userId,
		string	platform,
		string	confirmationCode,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

This method is used for authenticating users in Xsolla Login, who play on the consoles and other platforms where Xsolla Login isn't used. You must implement it on the your server side. Integration flow on the server side:

Generate server JWT
- Connect OAuth 2.0 server client Follow the instructions to connect the client and cope copy the Client ID and Secret key.
- Implement method: with application/x-www-form-urlencoded payload parameters:
  - client_id=YOUR_CLIENT_ID
  - client_secret=YOUR_CLIENT_SECRET
  - grant_type=client_credentials
Implement APIs for account linking with:
- Headers Content-Type: application/json and X-SERVER-AUTHORIZATION: YourGeneratedJwt
- Body See documentation.

Parameters

userId	Social platform (XBox, PS4, etc) user unique identifier.
platform	Platform name (XBox, PS4, etc).
confirmationCode	Code, taken from unified account.
onSuccess	Success operation callback.
onError	Called after the request resulted with an error.

See also: Xsolla.Auth.XsollaAuth.SignInConsoleAccount, RequestLinkingCode

◆ LinkDeviceToAccount()

static void Xsolla.UserAccount.XsollaUserAccount.LinkDeviceToAccount	(	Action	onSuccess,
		Action< Error >	onError,
		DeviceInfo	deviceInfo = `null`
	)

inlinestatic

Links the specified device to the current user account.

More about the use cases.

Parameters

onSuccess	Called after successful linking of the device.
onError	Called after the request resulted with an error.
deviceInfo	Information about the device that is used to identify the user. if not specified, the method defines this infotmation automatically.

◆ LinkSocialProvider()

static void Xsolla.UserAccount.XsollaUserAccount.LinkSocialProvider	(	SocialProvider	providerName,
		Action< LinkSocialProviderLink >	onSuccess,
		Action< Error >	onError,
		string	redirectUri = `null`
	)

inlinestatic

Links a social network that can be used for authentication to the current account.

More about the use cases.

Parameters

providerName	Name of a social network. Provider must be connected to Login in Publisher Account. Can be `amazon`, `apple`, `baidu`, `battlenet`, `discord`, `facebook`, `github`, `google`, `instagram`, `kakao`, `linkedin`, `mailru`, `microsoft`, `msn`, `naver`, `ok`, `paradox`, `paypal`, `psn`, `qq`, `reddit`, `steam`, `twitch`, `twitter`, `vimeo`, `vk`, `wechat`, `weibo`, `yahoo`, `yandex`, `youtube`, `xbox`, `playstation`.
onSuccess	Called after the URL for social authentication was successfully received.
onError	Called after the request resulted with an error.
redirectUri	URI to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the OAuth 2.0 redirect URIs specified in Publisher Account. Required if there are several URIs.

◆ RemoveUserAttributes()

static void Xsolla.UserAccount.XsollaUserAccount.RemoveUserAttributes	(	List< string >	removingKeys,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Removes user attributes with the specified IDs. Changes are made on the user data storage side (server side).

More about the use cases.

Parameters

removingKeys	List of attribute keys for removal.
onSuccess	Called after successful user attributes removal on the server side.
onError	Called after the request resulted with an error.

See also: GetUserAttributes, UpdateUserAttributes

◆ RequestLinkingCode()

static void Xsolla.UserAccount.XsollaUserAccount.RequestLinkingCode	(	Action< LinkingCode >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Creates the code for linking the platform account to the existing main account when the user logs in to the game via a gaming console. The call is used with Link accounts by code request.

More about the use cases.

Parameters

onSuccess	Called after successful linking code creation.
onError	Called after the request resulted with an error.

See also: Xsolla.Auth.XsollaAuth.SignInConsoleAccount, LinkConsoleAccount

◆ SearchUsers()

static void Xsolla.UserAccount.XsollaUserAccount.SearchUsers	(	string	nickname,
		int	offset,
		int	limit,
		Action< FoundUsers >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Searches users by the nickname parameter and gets a list of them. Search can be performed instantly when the user starts entering the search parameter. NOTE: User can search only 1 time per second.

Parameters

nickname	The search string that may contain: Nickname only, Tag only, Nickname and tag together
offset	Number of the elements from which the list is generated.
limit	Maximum number of users that are returned at a time.
onSuccess	Called after user search is successfully completed.
onError	Called after the request resulted with an error.

◆ UnlinkDeviceFromAccount()

static void Xsolla.UserAccount.XsollaUserAccount.UnlinkDeviceFromAccount	(	int	deviceId,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Unlinks the specified device from the current user account.

More about the use cases.

Parameters

deviceId	Platform specific unique device ID. For Android, it is an ANDROID_ID constant. For iOS, it is an identifierForVendor property.
onSuccess	Called after successful unlinking of the device.
onError	Called after the request resulted with an error.

◆ UnlinkSocialProvider()

static void Xsolla.UserAccount.XsollaUserAccount.UnlinkSocialProvider	(	SocialProvider	providerName,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Unlinks social network that can be used for authentication from the current user account.

Parameters

providerName	Name of a social network. Provider must be connected to Login in Publisher Account. Can be `amazon`, `apple`, `baidu`, `battlenet`, `discord`, `facebook`, `github`, `google`, `instagram`, `kakao`, `linkedin`, `mailru`, `microsoft`, `msn`, `naver`, `ok`, `paradox`, `paypal`, `psn`, `qq`, `reddit`, `steam`, `twitch`, `twitter`, `vimeo`, `vk`, `wechat`, `weibo`, `yahoo`, `yandex`, `youtube`, `xbox`, `playstation`.
onSuccess	Called after the social network successfully unlinked.
onError	Called after the request resulted with an error.

◆ UpdateUserAttributes()

static void Xsolla.UserAccount.XsollaUserAccount.UpdateUserAttributes	(	List< UserAttribute >	attributes,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Updates the values of user attributes with the specified IDs. The method can be used to create or remove attributes. Changes are made on the user data storage side (server side).

More about the use cases.

Parameters

attributes	List of attributes of the specified game. To add attribute which does not exist, set this attribute to the `key` parameter. To update `value` of the attribute, specify its `key` parameter and set the new `value`. You can change several attributes at a time.
onSuccess	Called after successful user attributes modification on the server side.
onError	Called after the request resulted with an error.

See also: GetUserAttributes, RemoveUserAttributes

◆ UpdateUserFriends()

static void Xsolla.UserAccount.XsollaUserAccount.UpdateUserFriends	(	FriendAction	action,
		string	user,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Modifies relationships with the specified user.

Parameters

action	Type of the action.
user	Identifier of the user to change relationship with.
onSuccess	Called after successful user friends data modification.
onError	Called after the request resulted with an error.

◆ UpdateUserInfo()

static void Xsolla.UserAccount.XsollaUserAccount.UpdateUserInfo	(	UserInfoUpdate	info,
		Action< UserInfo >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Updates the specified user’s information. Changes are made on the user data storage side.

More about the use cases.

Parameters

info	User information.
onSuccess	Called after successful user details modification.
onError	Called after the request resulted with an error.

◆ UpdateUserPhoneNumber()

static void Xsolla.UserAccount.XsollaUserAccount.UpdateUserPhoneNumber	(	string	phoneNumber,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Changes the user’s phone number that is used for two-factor authentication. Changes are made on the user data storage side (server-side).

More about the use cases.

Parameters

phoneNumber	Updated user phone number according to national conventions.
onSuccess	Called after user phone number was successfully modified.
onError	Called after the request resulted with an error.

See also: GetUserPhoneNumber, DeleteUserPhoneNumber

◆ UpdateUserSocialFriends()

static void Xsolla.UserAccount.XsollaUserAccount.UpdateUserSocialFriends	(	Action	onSuccess,
		Action< Error >	onError,
		SocialProvider	platform = `SocialProvider.None`
	)

inlinestatic

Begins data processing to update a list of user’s friends from a social provider. Note that there may be a delay in data processing because of the Xsolla Login server or provider server high loads.

Parameters

onSuccess	Called after user friends were successfully received.
onError	Called after the request resulted with an error.
platform	Name of a social network. Provider must be connected to Login in Publisher Account. Can be `amazon`, `apple`, `baidu`, `battlenet`, `discord`, `facebook`, `github`, `google`, `kakao`, `linkedin`, `mailru`, `microsoft`, `msn`, `naver`, `ok`, `paypal`, `psn`, `qq`, `reddit`, `steam`, `twitch`, `twitter`, `vimeo`, `vk`, `wechat`, `weibo`, `yahoo`, `yandex`, `youtube`, or `xbox`. If you do not specify it, the call gets friends from all social providers.

◆ UploadUserPicture()

static void Xsolla.UserAccount.XsollaUserAccount.UploadUserPicture	(	byte[]	pictureData,
		string	boundary,
		Action< string >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Changes the user’s avatar. Changes are made on the user data storage side (server side).

More about the use cases.

Parameters

pictureData	User profile picture in the binary format.
boundary
onSuccess	Called after the user profile picture was successfully modified.
onError	Called after the request resulted with an error.

See also: DeleteUserPicture

The documentation for this class was generated from the following file:

Assets/Xsolla/UserAccount/XsollaUserAccount.cs

Static Public Member Functions

Member Function Documentation

◆ AddUsernameEmailAuthToAccount()

◆ CheckUserAge()

◆ DeleteUserPhoneNumber()

◆ DeleteUserPicture()

◆ GetLinkedSocialProviders()

◆ GetPublicInfo()

◆ GetUserAttributes()

◆ GetUserDevices()

◆ GetUserEmail()

◆ GetUserFriends()

◆ GetUserPhoneNumber()

◆ GetUserSocialFriends()

◆ LinkConsoleAccount()

◆ LinkDeviceToAccount()

◆ LinkSocialProvider()

◆ RemoveUserAttributes()

◆ RequestLinkingCode()

◆ SearchUsers()

◆ UnlinkDeviceFromAccount()

◆ UnlinkSocialProvider()

◆ UpdateUserAttributes()

◆ UpdateUserFriends()

◆ UpdateUserInfo()

◆ UpdateUserPhoneNumber()

◆ UpdateUserSocialFriends()

◆ UploadUserPicture()