AccelByte.Server.ServerUserAccount Class Reference

Inheritance diagram for AccelByte.Server.ServerUserAccount:

Public Member Functions
void	GetUserData (string userAuthToken, ResultCallback< UserData > callback)
	Get User Data by Authorization Token.
void	SearchUserOtherPlatformDisplayName (string platformDisplayName, PlatformType platformType, ResultCallback< PagedUserOtherPlatformInfo > callback, int limit=20, int offset=0)
	This function will search user by their third party Display Name. The query will be used to find the user with the most approximate display name.
void	SearchUserOtherPlatformUserId (string platformUserId, PlatformType platformType, ResultCallback< UserOtherPlatformInfo > callback)
	This function will search user by their third party Platform User ID.
void	BanUser (string userId, BanType banType, BanReason reason, DateTime endDate, string comment, bool notifyUser, ResultCallback< UserBanResponseV3 > callback)
	Ban a Single User. Only Moderator that can ban other user.
void	ChangeUserBanStatus (string userId, string banId, bool enabled, ResultCallback< UserBanResponseV3 > callback)
	Change Ban Status of a Single User (enabled/disabled). Only Moderator that can change ban status.
void	GetUserBanInfo (string userId, ResultCallback< UserBanPagedList > callback, bool activeOnly=true)
	Get User Ban Information Only Moderator that can get the ban information.
void	GetUserBannedList (BanType banType, int offset, int limit, ResultCallback< UserBanPagedList > callback, bool activeOnly=true)
	Get User Banned List Only Moderator that can get the banned list.
void	GetUserByUserId (string userId, ResultCallback< UserData > callback)
	Get user data from another user by user id.
void	ListUserByUserId (ListUserDataRequest listUserDataRequest, ResultCallback< ListUserDataResponse > callback)
	This function to List user by user ids.
void	GetBulkUserByEmailAddress (IEnumerable< string > emailAddresses, ResultCallback< GetBulkUserByEmailAddressResponse > callback)
	Search user by the list of email addresses.
void	GetLinkedPlatformAccounts (string userId, GetLinkedPlatformAccountsOptionalParams optionalParameters, ResultCallback< PagedPlatformLinks > callback)
	Retrieves platform accounts linked to user.
void	GetLinkedPlatformAccounts (string userId, ResultCallback< PagedPlatformLinks > callback)
	Retrieves platform accounts linked to user.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Member Function Documentation

BanUser()

void AccelByte.Server.ServerUserAccount.BanUser ( string userId, BanType banType, BanReason reason, DateTime endDate, string comment, bool notifyUser, ResultCallback< UserBanResponseV3 > callback )

inline

Ban a Single User. Only Moderator that can ban other user.

Parameters

userId	Ban user's user ID
banType	The type of Ban
reason	The reason of Banning
endDate	The date when the ban is lifted
comment	The detail or comment about the banning
notifyUser	Notify user via email or not
callback	Returns a result via callback when completed

ChangeUserBanStatus()

void AccelByte.Server.ServerUserAccount.ChangeUserBanStatus ( string userId, string banId, bool enabled, ResultCallback< UserBanResponseV3 > callback )

inline

Change Ban Status of a Single User (enabled/disabled). Only Moderator that can change ban status.

Parameters

userId	Banned user's user ID
banId	Banned user's ban ID
enabled	Banned Status, false to disabled
callback	Returns a result via callback when completed

GetBulkUserByEmailAddress()

void AccelByte.Server.ServerUserAccount.GetBulkUserByEmailAddress ( IEnumerable< string > emailAddresses, ResultCallback< GetBulkUserByEmailAddressResponse > callback )

inline

Search user by the list of email addresses.

Parameters

emailAddresses	List of user email address to search
callback	Returns a result via callback when completed

GetLinkedPlatformAccounts() [1/2]

void AccelByte.Server.ServerUserAccount.GetLinkedPlatformAccounts ( string userId, GetLinkedPlatformAccountsOptionalParams optionalParameters, ResultCallback< PagedPlatformLinks > callback )

inline

Retrieves platform accounts linked to user.

Parameters

userId	User id to get the linked platform accounts
optionalParameters	Optional params to get linked platform accounts
callback	Returns a result via callback when completed

GetLinkedPlatformAccounts() [2/2]

void AccelByte.Server.ServerUserAccount.GetLinkedPlatformAccounts ( string userId, ResultCallback< PagedPlatformLinks > callback )

inline

Retrieves platform accounts linked to user.

Parameters

userId	User id to get the linked platform accounts
callback	Returns a result via callback when completed

GetUserBanInfo()

void AccelByte.Server.ServerUserAccount.GetUserBanInfo ( string userId, ResultCallback< UserBanPagedList > callback, bool activeOnly = true )

inline

Get User Ban Information Only Moderator that can get the ban information.

Parameters

userId	Banned user's user ID
callback	Returns a result via callback when completed

GetUserBannedList()

void AccelByte.Server.ServerUserAccount.GetUserBannedList ( BanType banType, int offset, int limit, ResultCallback< UserBanPagedList > callback, bool activeOnly = true )

inline

Get User Banned List Only Moderator that can get the banned list.

Parameters

banType	The type of Ban
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)
callback	Returns a result via callback when completed
activeOnly	true to only get the enabled banned list

GetUserByUserId()

void AccelByte.Server.ServerUserAccount.GetUserByUserId ( string userId, ResultCallback< UserData > callback )

inline

Get user data from another user by user id.

Parameters

userId

user id that needed to get user data

GetUserData()

void AccelByte.Server.ServerUserAccount.GetUserData ( string userAuthToken, ResultCallback< UserData > callback )

inline

Get User Data by Authorization Token.

Parameters

userAuthToken	User's authorization token
callback	Returns a UserData via callback when completed.

ListUserByUserId()

void AccelByte.Server.ServerUserAccount.ListUserByUserId ( ListUserDataRequest listUserDataRequest, ResultCallback< ListUserDataResponse > callback )

inline

This function to List user by user ids.

Parameters

listUserDataRequest	Struct request containing user ids
callback	Returns a result via callback when completed

SearchUserOtherPlatformDisplayName()

void AccelByte.Server.ServerUserAccount.SearchUserOtherPlatformDisplayName ( string platformDisplayName, PlatformType platformType, ResultCallback< PagedUserOtherPlatformInfo > callback, int limit = 20, int offset = 0 )

inline

This function will search user by their third party Display Name. The query will be used to find the user with the most approximate display name.

Parameters

platformDisplayName	Targeted user's third party by Display Name.
platformType	The platform type want to use to search user
callback	Returns a PagedUserOtherPlatformInfo via callback when completed.
limit	The limit of the users data result. Default value is 20.
offset	The offset of the users data result. Default value is 0.

SearchUserOtherPlatformUserId()

void AccelByte.Server.ServerUserAccount.SearchUserOtherPlatformUserId ( string platformUserId, PlatformType platformType, ResultCallback< UserOtherPlatformInfo > callback )

inline

This function will search user by their third party Platform User ID.

Parameters

platformUserId	Targeted user's third party user id.
platformType	The platform type want to use to search user
callback	Returns a UserOtherPlatformInfo via callback when completed.