Loading...
Searching...
No Matches
AccelByte.Server.ServerStatistic Class Reference
Inheritance diagram for AccelByte.Server.ServerStatistic:

Public Member Functions

void CreateUserStatItems (string userId, CreateStatItemRequest[] statItems, ResultCallback< StatItemOperationResult[]> callback)
 Create stat items of a user.
void GetAllUserStatItems (string userId, ResultCallback< PagedStatItems > callback, int offset=0, int limit=20, StatisticSortBy sortBy=StatisticSortBy.UpdatedAtAsc)
 Get all stat items of a user.
void GetUserStatItems (string userId, ResultCallback< PagedStatItems > callback)
 Get stat items of a user, filter by statCodes and tags.
void GetUserStatItems (string userId, GetUserStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback)
 Get stat items of a user, filter by statCodes and tags.
void GetUserStatItems (string userId, ICollection< string > statCodes, ICollection< string > tags, ResultCallback< PagedStatItems > callback, int offset=0, int limit=20, StatisticSortBy sortBy=StatisticSortBy.UpdatedAtAsc)
 Get stat items of a user, filter by statCodes and tags.
void IncrementUserStatItems (string userId, StatItemIncrement[] increments, ResultCallback< StatItemOperationResult[]> callback)
 Increment stat items for a user.
void IncrementManyUsersStatItems (UserStatItemIncrement[] increments, ResultCallback< StatItemOperationResult[]> callback)
 Increment stat items for many users.
void ResetUserStatItems (string userId, StatItemReset[] resets, ResultCallback< StatItemOperationResult[]> callback)
 Reset stat items for a user.
void ResetManyUsersStatItems (UserStatItemReset[] resets, ResultCallback< StatItemOperationResult[]> callback)
 Reset stat items for many users.
void UpdateUserStatItems (string userId, StatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback)
 Update stat items for a user.
void UpdateUserStatItems (string userId, string additionalKey, StatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback)
 Update stat items for a user.
void UpdateManyUsersStatItems (UserStatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback)
 Update stat items for many users.
void BulkFetchUserStatItemValues (string statCode, string[] userIds, string additionalKey, ResultCallback< FetchUser[]> callback)
 Bulk fetch multiple user's stat item values for a given namespace and statCode. If stat item does not exist, will return default value.
void BulkFetchStatItemsValue (string statCode, string[] userIds, ResultCallback< FetchUserStatistic > callback)
 Bulk fetch multiple user's stat item values for a given namespace and statCode.
void BulkUpdateMultipleUserStatItemsValue (UpdateUserStatItem[] bulkUpdateMultipleUserStatItem, ResultCallback< UpdateUserStatItemsResponse[]> callback)
 Bulk update multiple user's statitems value with specific update strategy.
void BulkResetUserStatItemsValues (string userId, string additionalKey, UserStatItem[] bulkUserStatItems, ResultCallback< UpdateUserStatItemsResponse[]> callback)
 Bulk reset user's statitem values for given namespace and user.
void BulkUpdateUserStatItemValue (string userId, string additionalKey, UpdateUserStatItemWithStatCode[] bulkUpdateUserStatItem, ResultCallback< UpdateUserStatItemsResponse[]> callback)
 Bulk update user's statitems value for given namespace and user with specific update strategy.
void UpdateUserStatItemValue (string userId, string statCode, string additionalKey, UpdateUserStatItem updateUserStatItem, ResultCallback< UpdateUserStatItemValueResponse > callback)
 Update user's statitem value for a given namespace and user with a certain update strategy.
void DeleteUserStatItems (string userId, string statCode, string additionalKey, ResultCallback callback)
 Delete user's stat items for given namespace, statCode, and user Id. If query param additionalKey is provided, it will delete user stat items of specific key (i.e. characterName). Otherwise, it will delete all stat items related to the user Id.
void GetGlobalStatItemsByStatCode (string statCode, ResultCallback< GlobalStatItem > callback)
 Get global statistic item by statistic code.
void GetListStatCycleConfigs (ResultCallback< PagedStatCycleConfigs > callback, StatisticCycleType type=StatisticCycleType.None, StatisticCycleStatus status=StatisticCycleStatus.None, int offset=0, int limit=20)
 Get list of statistic cycle config.
void ListUserStatCycleItems (string userId, string cycleId, ResultCallback< ListUserStatCycleItemsResult > callback)
 Fetch the list of user's stat cycle items.
void ListUserStatCycleItems (string userId, string cycleId, ListUserStatCycleItemsOptionalParameters optionalParameters, ResultCallback< ListUserStatCycleItemsResult > callback)
 Fetch the list of user's stat cycle items.

Additional Inherited Members

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

Member Function Documentation

◆ BulkFetchStatItemsValue()

void AccelByte.Server.ServerStatistic.BulkFetchStatItemsValue ( string statCode,
string[] userIds,
ResultCallback< FetchUserStatistic > callback )
inline

Bulk fetch multiple user's stat item values for a given namespace and statCode.

Parameters
statCodeThis is the StatCode that will be stored in the slot.
userIdsThis is the UserId array that will be stored in the slot.
callbackReturns an array of FetchUserStatistic via callback when completed

◆ BulkFetchUserStatItemValues()

void AccelByte.Server.ServerStatistic.BulkFetchUserStatItemValues ( string statCode,
string[] userIds,
string additionalKey,
ResultCallback< FetchUser[]> callback )
inline

Bulk fetch multiple user's stat item values for a given namespace and statCode. If stat item does not exist, will return default value.

Parameters
statCodeThis is the StatCode that will be stored in the slot.
userIdsThis is the UserId array that will be stored in the slot.
additionalKeyThis is the AdditionalKey that will be stored in the slot.
callbackReturns an array of FetchUser via callback when completed

◆ BulkResetUserStatItemsValues()

void AccelByte.Server.ServerStatistic.BulkResetUserStatItemsValues ( string userId,
string additionalKey,
UserStatItem[] bulkUserStatItems,
ResultCallback< UpdateUserStatItemsResponse[]> callback )
inline

Bulk reset user's statitem values for given namespace and user.

Parameters
userIdThis is the UserId that will be stored in the slot.
additionalKeyThis is the AdditionalKey that will be stored in the slot.
bulkUserStatItemsThis is the BulkUserStatItem array that will be stored in the slot.
callbackReturns an array of UpdateUserStatItemsResponse via callback when completed

◆ BulkUpdateMultipleUserStatItemsValue()

void AccelByte.Server.ServerStatistic.BulkUpdateMultipleUserStatItemsValue ( UpdateUserStatItem[] bulkUpdateMultipleUserStatItem,
ResultCallback< UpdateUserStatItemsResponse[]> callback )
inline

Bulk update multiple user's statitems value with specific update strategy.

Parameters
bulkUpdateMultipleUserStatItemThis is the BulkUpdateMultipleUserStatItem array that will be stored in the slot.
callbackReturns an array of UpdateUserStatItemsResponse via callback when completed

◆ BulkUpdateUserStatItemValue()

void AccelByte.Server.ServerStatistic.BulkUpdateUserStatItemValue ( string userId,
string additionalKey,
UpdateUserStatItemWithStatCode[] bulkUpdateUserStatItem,
ResultCallback< UpdateUserStatItemsResponse[]> callback )
inline

Bulk update user's statitems value for given namespace and user with specific update strategy.

Parameters
userIdUserId of a user
additionalKeyThis is the AdditionalKey that will be stored in the slot.
bulkUpdateUserStatItemThis is the BulkUpdateUserStatItem array that will be stored in the slot.
callbackReturns an array of UpdateUserStatItemsResponse via callback when completed

◆ CreateUserStatItems()

void AccelByte.Server.ServerStatistic.CreateUserStatItems ( string userId,
CreateStatItemRequest[] statItems,
ResultCallback< StatItemOperationResult[]> callback )
inline

Create stat items of a user.

Parameters
userIdUserId of a user
statItemsList of statCodes to be created for a user
callbackReturns all profile's StatItems via callback when completed

◆ DeleteUserStatItems()

void AccelByte.Server.ServerStatistic.DeleteUserStatItems ( string userId,
string statCode,
string additionalKey,
ResultCallback callback )
inline

Delete user's stat items for given namespace, statCode, and user Id. If query param additionalKey is provided, it will delete user stat items of specific key (i.e. characterName). Otherwise, it will delete all stat items related to the user Id.

Parameters
userIdThis is the UserId that will be stored in the slot.
statCodeThis is the StatCode that will be stored in the slot.
additionalKeyThis is the AdditionalKey that will be stored in the slot.
callbackReturns via callback when completed

◆ GetAllUserStatItems()

void AccelByte.Server.ServerStatistic.GetAllUserStatItems ( string userId,
ResultCallback< PagedStatItems > callback,
int offset = 0,
int limit = 20,
StatisticSortBy sortBy = StatisticSortBy::UpdatedAtAsc )
inline

Get all stat items of a user.

Parameters
userIdUserId of a user
callbackReturns all profile's StatItems via callback when completed
offsetOffset of the list that has been sliced based on Limit parameter (optional, default = 0)
limitThe limit of item on page (optional, default = 20)
sortByThe sorting method of item on page (optional, default = updated at and ascending)

◆ GetGlobalStatItemsByStatCode()

void AccelByte.Server.ServerStatistic.GetGlobalStatItemsByStatCode ( string statCode,
ResultCallback< GlobalStatItem > callback )
inline

Get global statistic item by statistic code.

Parameters
statCodeStatCode.
callbackReturns GlobalStatItem via callback when completed

◆ GetListStatCycleConfigs()

void AccelByte.Server.ServerStatistic.GetListStatCycleConfigs ( ResultCallback< PagedStatCycleConfigs > callback,
StatisticCycleType type = StatisticCycleType::None,
StatisticCycleStatus status = StatisticCycleStatus::None,
int offset = 0,
int limit = 20 )
inline

Get list of statistic cycle config.

Parameters
callbackReturns PagedStatCycleConfigs via callback
typeStatistic cycle type
statusStatistic cycle status
offsetOffset of the list that has been sliced based on Limit parameter (optional, default = 0)
limitThe limit of item on page (optional)

◆ GetUserStatItems() [1/3]

void AccelByte.Server.ServerStatistic.GetUserStatItems ( string userId,
GetUserStatItemsOptionalParam optionalParam,
ResultCallback< PagedStatItems > callback )
inline

Get stat items of a user, filter by statCodes and tags.

Parameters
userIdUserId of a user
optionalParamOptional parameters to be sent
callbackReturns all profile's StatItems via callback when completed

◆ GetUserStatItems() [2/3]

void AccelByte.Server.ServerStatistic.GetUserStatItems ( string userId,
ICollection< string > statCodes,
ICollection< string > tags,
ResultCallback< PagedStatItems > callback,
int offset = 0,
int limit = 20,
StatisticSortBy sortBy = StatisticSortBy::UpdatedAtAsc )
inline

Get stat items of a user, filter by statCodes and tags.

Parameters
userIdUserId of a user
statCodesList of statCodes that will be included in the result
tagsList of tags that will be included in the result
callbackReturns all profile's StatItems via callback when completed
offsetOffset of the list that has been sliced based on Limit parameter (optional, default = 0)
limitThe limit of item on page (optional, default = 20)
sortByThe sorting method of item on page (optional, default = updated at and ascending)

◆ GetUserStatItems() [3/3]

void AccelByte.Server.ServerStatistic.GetUserStatItems ( string userId,
ResultCallback< PagedStatItems > callback )
inline

Get stat items of a user, filter by statCodes and tags.

Parameters
userIdUserId of a user
callbackReturns all profile's StatItems via callback when completed

◆ IncrementManyUsersStatItems()

void AccelByte.Server.ServerStatistic.IncrementManyUsersStatItems ( UserStatItemIncrement[] increments,
ResultCallback< StatItemOperationResult[]> callback )
inline

Increment stat items for many users.

Parameters
incrementsConsist of one or more statCode and value to update
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ IncrementUserStatItems()

void AccelByte.Server.ServerStatistic.IncrementUserStatItems ( string userId,
StatItemIncrement[] increments,
ResultCallback< StatItemOperationResult[]> callback )
inline

Increment stat items for a user.

Parameters
userIdUserId of a user
incrementsConsist of one or more statCode and value to update
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ ResetManyUsersStatItems()

void AccelByte.Server.ServerStatistic.ResetManyUsersStatItems ( UserStatItemReset[] resets,
ResultCallback< StatItemOperationResult[]> callback )
inline

Reset stat items for many users.

Parameters
resetsConsist of one or more userId and statCode to reset
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ ResetUserStatItems()

void AccelByte.Server.ServerStatistic.ResetUserStatItems ( string userId,
StatItemReset[] resets,
ResultCallback< StatItemOperationResult[]> callback )
inline

Reset stat items for a user.

Parameters
userIdUserId of a user
resetsConsist of one or more statCode
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ UpdateManyUsersStatItems()

void AccelByte.Server.ServerStatistic.UpdateManyUsersStatItems ( UserStatItemUpdate[] updates,
ResultCallback< StatItemOperationResult[]> callback )
inline

Update stat items for many users.

Parameters
updatesConsist of one or more userId and statCode with its udpate value and update strategy. OVERRIDE update strategy means it will replace the previous statCode value with the new value. INCREMENT update strategy with positive value means it will increase the previous statCode value. INCREMENT update strategy with negative value means it will decrease the previous statCode value. MAX update strategy means it will replace the previous statCode value with the new value if it's larger than the previous statCode value. MIN update strategy means it will replace the previous statCode value with the new value if it's lower than the previous statCode value.
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ UpdateUserStatItems() [1/2]

void AccelByte.Server.ServerStatistic.UpdateUserStatItems ( string userId,
StatItemUpdate[] updates,
ResultCallback< StatItemOperationResult[]> callback )
inline

Update stat items for a user.

Parameters
userIdUserId of a user
updatesConsist of one or more statCode with its udpate value and update strategy. OVERRIDE update strategy means it will replace the previous statCode value with the new value. INCREMENT update strategy with positive value means it will increase the previous statCode value. INCREMENT update strategy with negative value means it will decrease the previous statCode value. MAX update strategy means it will replace the previous statCode value with the new value if it's larger than the previous statCode value. MIN update strategy means it will replace the previous statCode value with the new value if it's lower than the previous statCode value.
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ UpdateUserStatItems() [2/2]

void AccelByte.Server.ServerStatistic.UpdateUserStatItems ( string userId,
string additionalKey,
StatItemUpdate[] updates,
ResultCallback< StatItemOperationResult[]> callback )
inline

Update stat items for a user.

Parameters
userIdUserId of a user
additionalKeyTo identify multi level user statItem, such as character
updatesConsist of one or more statCode with its udpate value and update strategy. OVERRIDE update strategy means it will replace the previous statCode value with the new value. INCREMENT update strategy with positive value means it will increase the previous statCode value. INCREMENT update strategy with negative value means it will decrease the previous statCode value. MAX update strategy means it will replace the previous statCode value with the new value if it's larger than the previous statCode value. MIN update strategy means it will replace the previous statCode value with the new value if it's lower than the previous statCode value.
callbackReturns an array of BulkStatItemOperationResult via callback when completed

◆ UpdateUserStatItemValue()

void AccelByte.Server.ServerStatistic.UpdateUserStatItemValue ( string userId,
string statCode,
string additionalKey,
UpdateUserStatItem updateUserStatItem,
ResultCallback< UpdateUserStatItemValueResponse > callback )
inline

Update user's statitem value for a given namespace and user with a certain update strategy.

Parameters
userIdUserId of a user
statCodeStatCode
additionalKeyThis is the AdditionalKey that will be stored in the slot.
updateUserStatItemThis is the FAccelByteModelsUpdateUserStatItem that will be stored in the slot.
Parameters
callbackReturns an array of UpdateUserStatItemValueResponse via callback when completed