Loading...
Searching...
No Matches
AccelByte::Api::Statistic Class Reference

Statistic API to manage user's in-game profiles's statistic. More...

#include <AccelByteStatisticApi.h>

Inheritance diagram for AccelByte::Api::Statistic:

Public Member Functions

 Statistic (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
 Statistic (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr CreateUserStatItems (TArray< FString > const &StatCodes, THandler< TArray< FAccelByteModelsBulkStatItemOperationResult > > const &OnSuccess, FErrorHandler const &OnError)
 Create a stat item.
FAccelByteTaskWPtr GetAllUserStatItems (THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteStatisticSortBy SortBy=EAccelByteStatisticSortBy::UPDATED_AT_ASC)
 Get all this user stat items.
FAccelByteTaskWPtr GetUserStatItems (TArray< FString > const &StatCodes, TArray< FString > const &Tags, THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteStatisticSortBy SortBy=EAccelByteStatisticSortBy::UPDATED_AT_ASC)
 Get this user stat items by specifying statCodes and tags to get from. Returned stat items will only contain stat items specified by statCodes and tags (inclusive).
FAccelByteTaskWPtr GetUserStatItems (FString const &UserId, TArray< FString > const &StatCodes, TArray< FString > const &Tags, THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteStatisticSortBy SortBy=EAccelByteStatisticSortBy::UPDATED_AT_ASC)
 Get user's specified stat items and specifying statCodes and tags to get from. Returned stat items will only contain stat items specified by statCodes and tags (inclusive).
FAccelByteTaskWPtr IncrementUserStatItems (TArray< FAccelByteModelsBulkStatItemInc > const &Data, THandler< TArray< FAccelByteModelsBulkStatItemOperationResult > > const &OnSuccess, FErrorHandler const &OnError)
 Increment this user stat items.
FAccelByteTaskWPtr ListUserStatItems (TArray< FString > const &StatCodes, TArray< FString > const &Tags, FString const &AdditionalKey, THandler< TArray< FAccelByteModelsFetchUser > > const &OnSuccess, FErrorHandler const &OnError)
 Public list all statItems of user. NOTE: If stat code does not exist, will ignore this stat code. If stat item does not exist, will return default value.
FAccelByteTaskWPtr BulkUpdateUserStatItemsValue (FString const &AdditionalKey, TArray< FAccelByteModelsUpdateUserStatItemWithStatCode > const &BulkUpdateUserStatItems, THandler< TArray< FAccelByteModelsUpdateUserStatItemsResponse > > const &OnSuccess, FErrorHandler const &OnError)
 Public bulk update user's statitems value for given namespace and user with specific update strategy.
FAccelByteTaskWPtr UpdateUserStatItemsValue (FString const &StatCode, FString const &AdditionalKey, FAccelByteModelsPublicUpdateUserStatItem const &UpdateUserStatItem, THandler< FAccelByteModelsUpdateUserStatItemValueResponse > const &OnSuccess, FErrorHandler const &OnError)
 Public update user's statitem value for a given namespace and user with a certain update strategy.
FAccelByteTaskWPtr BulkFetchStatItemsValue (FString const &StatCode, TArray< FString > const &UserIds, THandler< TArray< FAccelByteModelsStatItemValueResponse > > const &OnSuccess, FErrorHandler const &OnError)
 Public bulk fetch multiple user's statitem value for a given namespace and statCode.
FAccelByteTaskWPtr ResetUserStatItemValue (FString const &StatCode, THandler< FAccelByteModelsUpdateUserStatItemValueResponse > const &OnSuccess, FErrorHandler const &OnError)
 Reset user's statitem value for a given namespace and user. User's statitem value will be reset to the default value defined in the statistic configuration.
FAccelByteTaskWPtr GetGlobalStatItemsByStatCode (FString const &StatCode, THandler< FAccelByteModelsGlobalStatItemValueResponse > const &OnSuccess, FErrorHandler const &OnError)
 Get global stat items by specifying statCodes.
FAccelByteTaskWPtr ListGlobalStatItems (THandler< FAccelByteModelsGlobalStatItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, TArray< FString > const &StatCodes={}, int32 Limit=20, int32 Offset=0)
 List global stat items.
FAccelByteTaskWPtr GetUserStatCycleItems (FString const &CycleId, THandler< FAccelByteModelsUserStatCycleItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, TArray< FString > const &StatCodes={})
 Get current user stat items within the cycle.
FAccelByteTaskWPtr GetUserStatCycleItems (FString const &CycleId, FString const &TargetUserId, THandler< FAccelByteModelsUserStatCycleItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, TArray< FString > const &StatCodes={})
 Get current user stat items within the cycle.
FAccelByteTaskWPtr GetStatCycleConfig (FString const &CycleId, THandler< FAccelByteModelsStatCycleConfig > const &OnSuccess, FErrorHandler const &OnError)
 Get Statistic Cycle Config.
FAccelByteTaskWPtr GetListStatCycleConfigs (EAccelByteCycle CycleType, THandler< FAccelByteModelsStatCycleConfigPagingResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0)
 Get List of Statistic Cycle Config.
FAccelByteTaskWPtr GetListStatCycleConfigs (FAccelByteModelsStatGetListStatCycleQueryRequest OptionalParams, THandler< FAccelByteModelsStatCycleConfigPagingResult > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0)
 Get List of Statistic Cycle Config.
FAccelByteTaskWPtr GetMyStatItems (TArray< FString > const &StatCodes, TArray< FString > const &Tags, THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteStatisticSortBy SortBy=EAccelByteStatisticSortBy::NONE, int32 Limit=20, int32 Offset=0)
 Get user's own statistic item.
FAccelByteTaskWPtr GetMyStatItemValues (TArray< FString > const &StatCodes, TArray< FString > const &Tags, FString const &AdditionalKey, THandler< TArray< FAccelByteModelsFetchUser > > const &OnSuccess, FErrorHandler const &OnError)
 Get user's own statistic value.
FAccelByteTaskWPtr GetMyStatCycleItems (FString const &CycleId, TArray< FString > const &StatCodes, THandler< FAccelByteModelsUserStatCycleItemPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteStatisticSortBy SortBy=EAccelByteStatisticSortBy::NONE, int32 Limit=20, int32 Offset=0)
 Get user's own statistic cycle item.
FAccelByteTaskWPtr BulkResetMultipleUserStatItemsValue (TArray< FAccelByteModelsResetUserStatItemValue > const &UserStatItemValue, THandler< TArray< FAccelByteModelsUpdateUserStatItemsResponse > > const &OnSuccess, FErrorHandler const &OnError)
 Bulk reset multiple user's statitems value. User's statitem value will be reset to the default value defined in the statistic configuration.
Public Member Functions inherited from AccelByte::FApiBase
 FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
 FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Static Public Member Functions

static FString ConvertUserStatisticSortByToString (EAccelByteStatisticSortBy SortBy)
static FString ConvertStatCycleStatisticSortByToString (EAccelByteStatisticStatCycleSortBy SortBy)

Additional Inherited Members

Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe > CredentialsRef
Settings const & SettingsRef
FHttpRetrySchedulerBaseHttpRef
FHttpClient HttpClient
FAccelBytePlatformPtr AccelBytePlatformPtr

Detailed Description

Statistic API to manage user's in-game profiles's statistic.

Member Function Documentation

◆ BulkFetchStatItemsValue()

FAccelByteTaskWPtr AccelByte::Api::Statistic::BulkFetchStatItemsValue ( FString const & StatCode,
TArray< FString > const & UserIds,
THandler< TArray< FAccelByteModelsStatItemValueResponse > > const & OnSuccess,
FErrorHandler const & OnError )

Public bulk fetch multiple user's statitem value for a given namespace and statCode.

Parameters
StatCodeStatCode.
UserIdsList of UserIds.
OnSuccessThis will be called when the operation succeeded. The result is TArray<FAccelByteModelsStatItemValueResponse>.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkResetMultipleUserStatItemsValue()

FAccelByteTaskWPtr AccelByte::Api::Statistic::BulkResetMultipleUserStatItemsValue ( TArray< FAccelByteModelsResetUserStatItemValue > const & UserStatItemValue,
THandler< TArray< FAccelByteModelsUpdateUserStatItemsResponse > > const & OnSuccess,
FErrorHandler const & OnError )

Bulk reset multiple user's statitems value. User's statitem value will be reset to the default value defined in the statistic configuration.

Parameters
UserStatItemValueArray of UserId and StatCode.
OnSuccessThis will be called when the operation succeeded. The result is TArray<FAccelByteModelsUpdateUserStatItemsResponse>.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkUpdateUserStatItemsValue()

FAccelByteTaskWPtr AccelByte::Api::Statistic::BulkUpdateUserStatItemsValue ( FString const & AdditionalKey,
TArray< FAccelByteModelsUpdateUserStatItemWithStatCode > const & BulkUpdateUserStatItems,
THandler< TArray< FAccelByteModelsUpdateUserStatItemsResponse > > const & OnSuccess,
FErrorHandler const & OnError )

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

Parameters
AdditionalKeyThis is the AdditionalKey that will be stored in the slot.
BulkUpdateUserStatItemsThis is the BulkUpdateUserStatItem array that will be stored in the slot.
OnSuccessThis will be called when the operation succeeded. The result is an array of FAccelByteModelsUpdateUserStatItemsResponse.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateUserStatItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::CreateUserStatItems ( TArray< FString > const & StatCodes,
THandler< TArray< FAccelByteModelsBulkStatItemOperationResult > > const & OnSuccess,
FErrorHandler const & OnError )

Create a stat item.

Parameters
StatCodesSpecify statCodes for stat items to get from this method
OnSuccessThis will be called when the operation succeeded. The result is an FAccelByteModelsBulkStatItemOperationResult.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetAllUserStatItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetAllUserStatItems ( THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0,
EAccelByteStatisticSortBy SortBy = EAccelByteStatisticSortBy::UPDATED_AT_ASC )

Get all this user stat items.

Parameters
OnSuccessThis will be called when the operation succeeded. The result is an FAccelByteModelsUserStatItemPagingSlicedResult.
OnErrorThis will be called when the operation failed.
LimitPage size, default value is 20.
OffsetPage number, default value is 0.
SortByThe container to store sortby.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGlobalStatItemsByStatCode()

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetGlobalStatItemsByStatCode ( FString const & StatCode,
THandler< FAccelByteModelsGlobalStatItemValueResponse > const & OnSuccess,
FErrorHandler const & OnError )

Get global stat items by specifying statCodes.

Parameters
StatCodeThe StatCode of the global stat items
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsGlobalStatItemValueResponse.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListStatCycleConfigs() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetListStatCycleConfigs ( EAccelByteCycle CycleType,
THandler< FAccelByteModelsStatCycleConfigPagingResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0 )

Get List of Statistic Cycle Config.

Parameters
CycleType
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsStatCycleConfig
OnErrorThis will be called when the operation failed
LimitPage size, default value is 20.
OffsetPage number, default value is 0
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListStatCycleConfigs() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetListStatCycleConfigs ( FAccelByteModelsStatGetListStatCycleQueryRequest OptionalParams,
THandler< FAccelByteModelsStatCycleConfigPagingResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0 )

Get List of Statistic Cycle Config.

Parameters
OptionalParamsOptional parameter to do the query
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsStatCycleConfig
OnErrorThis will be called when the operation failed
LimitPage size, default value is 20.
OffsetPage number, default value is 0
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetMyStatCycleItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetMyStatCycleItems ( FString const & CycleId,
TArray< FString > const & StatCodes,
THandler< FAccelByteModelsUserStatCycleItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
EAccelByteStatisticSortBy SortBy = EAccelByteStatisticSortBy::NONE,
int32 Limit = 20,
int32 Offset = 0 )

Get user's own statistic cycle item.

Parameters
CycleIdThe cycle id to which the stat item belong
StatCodesArray of statistic codes for statistic cycle item to be retrieved
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsUserStatCycleItemPagingSlicedResult
OnErrorThis will be called when the operation failed
SortBy
LimitPage size, default value is 20
OffsetPage number, default value is 0
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetMyStatItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetMyStatItems ( TArray< FString > const & StatCodes,
TArray< FString > const & Tags,
THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
EAccelByteStatisticSortBy SortBy = EAccelByteStatisticSortBy::NONE,
int32 Limit = 20,
int32 Offset = 0 )

Get user's own statistic item.

Parameters
StatCodesArray of statistic codes to be retrieved
TagsArray of tags which the statistic items to be retrieved have
OnSuccessThil will be called when the operation succeeded. The result is FAccelByteModelsUserStatItemPagingSlicedResult
OnErrorThis will be called when the operation failed
SortBy
LimitPage size, default value is 20
OffsetPage number, default value is 0
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetMyStatItemValues()

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetMyStatItemValues ( TArray< FString > const & StatCodes,
TArray< FString > const & Tags,
FString const & AdditionalKey,
THandler< TArray< FAccelByteModelsFetchUser > > const & OnSuccess,
FErrorHandler const & OnError )

Get user's own statistic value.

Parameters
StatCodesArray of statistic codes for statistic value to be retrieved
TagsArray of tags that statistic item to be retrieved has
AdditionalKeyAdditional key
OnSuccessThis will be called when the operation succeeded. The result is TArray<FAccelByteModelsFetchUser>
OnErrorThis will be called when the operation failed
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetStatCycleConfig()

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetStatCycleConfig ( FString const & CycleId,
THandler< FAccelByteModelsStatCycleConfig > const & OnSuccess,
FErrorHandler const & OnError )

Get Statistic Cycle Config.

Parameters
CycleIdThe CycleId of the config
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsStatCycleConfig
OnErrorThis will be called when the operation failed
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserStatCycleItems() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetUserStatCycleItems ( FString const & CycleId,
FString const & TargetUserId,
THandler< FAccelByteModelsUserStatCycleItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0,
TArray< FString > const & StatCodes = {} )

Get current user stat items within the cycle.

Parameters
CycleIdthe CycleId where the stat items belong to
TargetUserIdthe user Id to be queried
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsUserStatCycleItemPagingSlicedResult
OnErrorThis will be called when the operation failed
LimitPage size, default value is 20.
OffsetPage number, default value is 0.
StatCodesOptional. the StatCode of the user stat item. Determine which stat code to get with the cycle id.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserStatCycleItems() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetUserStatCycleItems ( FString const & CycleId,
THandler< FAccelByteModelsUserStatCycleItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0,
TArray< FString > const & StatCodes = {} )

Get current user stat items within the cycle.

Parameters
CycleIdthe CycleId where the stat items belong to
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsUserStatCycleItemPagingSlicedResult
OnErrorThis will be called when the operation failed
LimitPage size, default value is 20.
OffsetPage number, default value is 0.
StatCodesOptional. the StatCode of the user stat item. Determine which stat code to get with the cycle id.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserStatItems() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetUserStatItems ( FString const & UserId,
TArray< FString > const & StatCodes,
TArray< FString > const & Tags,
THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0,
EAccelByteStatisticSortBy SortBy = EAccelByteStatisticSortBy::UPDATED_AT_ASC )

Get user's specified stat items and specifying statCodes and tags to get from. Returned stat items will only contain stat items specified by statCodes and tags (inclusive).

Parameters
UserIdThe Id of a user that will be given his stat items
StatCodesSpecify statCodes for stat items to get from this method
TagsSpecify tags for for stat items to get from this method
OnSuccessThis will be called when the operation succeeded. Thre result is an FAccelByteModelsUserStatItemPagingSlicedResult
OnErrorThis will be called when the operation failed.
LimitPage size, default value is 20.
OffsetPage number, default value is 0.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserStatItems() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Statistic::GetUserStatItems ( TArray< FString > const & StatCodes,
TArray< FString > const & Tags,
THandler< FAccelByteModelsUserStatItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
int32 Limit = 20,
int32 Offset = 0,
EAccelByteStatisticSortBy SortBy = EAccelByteStatisticSortBy::UPDATED_AT_ASC )

Get this user stat items by specifying statCodes and tags to get from. Returned stat items will only contain stat items specified by statCodes and tags (inclusive).

Parameters
StatCodesSpecify statCodes for stat items to get from this method
TagsSpecify tags for for stat items to get from this method
OnSuccessThis will be called when the operation succeeded. Thre result is an FAccelByteModelsUserStatItemPagingSlicedResult
OnErrorThis will be called when the operation failed.
LimitPage size, default value is 20.
OffsetPage number, default value is 0.
SortByThe container to store sortby.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ IncrementUserStatItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::IncrementUserStatItems ( TArray< FAccelByteModelsBulkStatItemInc > const & Data,
THandler< TArray< FAccelByteModelsBulkStatItemOperationResult > > const & OnSuccess,
FErrorHandler const & OnError )

Increment this user stat items.

Parameters
Dataarray consist of increased value and stat code.
OnSuccessThis will be called when the operation succeeded. The result is an array of FAccelByteModelsBulkStatItemOperationResult.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ ListGlobalStatItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::ListGlobalStatItems ( THandler< FAccelByteModelsGlobalStatItemPagingSlicedResult > const & OnSuccess,
FErrorHandler const & OnError,
TArray< FString > const & StatCodes = {},
int32 Limit = 20,
int32 Offset = 0 )

List global stat items.

Parameters
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsGlobalStatItemValueResponse.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ ListUserStatItems()

FAccelByteTaskWPtr AccelByte::Api::Statistic::ListUserStatItems ( TArray< FString > const & StatCodes,
TArray< FString > const & Tags,
FString const & AdditionalKey,
THandler< TArray< FAccelByteModelsFetchUser > > const & OnSuccess,
FErrorHandler const & OnError )

Public list all statItems of user. NOTE: If stat code does not exist, will ignore this stat code. If stat item does not exist, will return default value.

Parameters
StatCodesStatCodes.
TagsThis is the Tag array that will be stored in the slot.
AdditionalKeyThis is the AdditionalKey that will be stored in the slot.
OnSuccessThis will be called when the operation succeeded. The result is an array of FAccelByteModelsFetchUser.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ ResetUserStatItemValue()

FAccelByteTaskWPtr AccelByte::Api::Statistic::ResetUserStatItemValue ( FString const & StatCode,
THandler< FAccelByteModelsUpdateUserStatItemValueResponse > const & OnSuccess,
FErrorHandler const & OnError )

Reset user's statitem value for a given namespace and user. User's statitem value will be reset to the default value defined in the statistic configuration.

Parameters
StatCodeStatCode.
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsUpdateUserStatItemValueResponse.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateUserStatItemsValue()

FAccelByteTaskWPtr AccelByte::Api::Statistic::UpdateUserStatItemsValue ( FString const & StatCode,
FString const & AdditionalKey,
FAccelByteModelsPublicUpdateUserStatItem const & UpdateUserStatItem,
THandler< FAccelByteModelsUpdateUserStatItemValueResponse > const & OnSuccess,
FErrorHandler const & OnError )

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

Parameters
StatCodeStatCode.
AdditionalKeyThis is the AdditionalKey that will be stored in the slot.
UpdateUserStatItemThis is the UpdateUserStatItem that will be stored in the slot.
OnSuccessThis will be called when the operation succeeded. The result is FAccelByteModelsUpdateUserStatItemValueResponse.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.