AccelByte.Api.Statistic Class Reference

Inheritance diagram for AccelByte.Api.Statistic:

Public Member Functions
void	CreateUserStatItems (CreateStatItemRequest[] statItems, ResultCallback< StatItemOperationResult[]> callback)
	Create stat items of a user. Before a user can have any data in a stat item, he/she needs to have that stat item created.
void	GetAllUserStatItems (ResultCallback< PagedStatItems > callback, int offset=0, int limit=20, StatisticSortBy sortBy=StatisticSortBy.UpdatedAtAsc)
	Get all stat items of a user.
void	GetUserStatItems (ResultCallback< PagedStatItems > callback)
	Get stat items of a user, filter by statCodes and tags.
void	GetUserStatItems (GetUserStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback)
	Get stat items of a user, filter by statCodes and tags.
void	GetUserStatItems (string targetUserId, ResultCallback< PagedStatItems > callback)
	Get stat items of a user, filter by statCodes and tags.
void	GetUserStatItems (string targetUserId, GetUserStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback)
	Get stat items of a user, filter by statCodes and tags.
void	GetUserStatItems (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 (StatItemIncrement[] increments, ResultCallback< StatItemOperationResult[]> callback)
	Update stat items for a users.
void	ResetUserStatItems (StatItemReset[] resets, ResultCallback< StatItemOperationResult[]> callback)
	Reset stat items for a user.
void	UpdateUserStatItems (StatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback)
	Update stat items with the specified update strategy for a user.
void	UpdateUserStatItems (string additionalKey, StatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback)
	Public bulk update user's statitems value for given namespace and user with specific update strategy.
void	ListUserStatItems (string[] statCodes, string[] tags, string additionalKey, ResultCallback< FetchUser[]> callback)
	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.
void	UpdateUserStatItemsValue (string statCode, string additionalKey, PublicUpdateUserStatItem updateUserStatItem, ResultCallback< UpdateUserStatItemValueResponse > callback)
	Public update user's statitem value for a given namespace and user with a certain update strategy.
void	BulkFetchStatItemsValue (string statCode, string[] userIds, ResultCallback< FetchUserStatistic > callback)
	Bulk fetch multiple user's stat item values for a given namespace and statCode.
void	GetGlobalStatItemsByStatCode (string statCode, ResultCallback< GlobalStatItem > callback)
	Get global statistic item by statistic code.
void	GetStatCycleConfig (string cycleId, ResultCallback< StatCycleConfig > callback)
	Get statistic cycle configuration data.
void	GetListStatCycleConfigs (ResultCallback< PagedStatCycleConfigs > callback, StatisticCycleType type=StatisticCycleType.None, StatisticCycleStatus status=StatisticCycleStatus.None, int offset=0, int limit=20)
	Get the list of statistic cycle configuration data that belongs to the current namespace.
void	GetListUserStatCycleItem (string cycleId, ResultCallback< PagedStatCycleItem > callback, int offset=0, int limit=20, string[] statCodes=null)
	Get list of user's statistic cycle item.
void	GetMyStatItems (ResultCallback< PagedStatItems > callback)
	Get user's own statistic item.
void	GetMyStatItems (GetMyStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback)
	Get user's own statistic item.
void	GetMyStatItems (IEnumerable< string > statCodes, IEnumerable< string > tags, ResultCallback< PagedStatItems > callback, int limit=20, int offset=0)
	Get user's own statistic item.
void	GetMyStatItemValues (string[] statCodes, string[] tags, string additionalKey, ResultCallback< FetchUser[]> callback)
	Get user's own statistic value.
void	GetMyStatCycleItems (string cycleId, ResultCallback< PagedStatCycleItem > callback)
	Get user's own statistic cycle item.
void	GetMyStatCycleItems (string cycleId, GetMyStatCycleItemsOptionalParam optionalParam, ResultCallback< PagedStatCycleItem > callback)
	Get user's own statistic cycle item.
void	GetMyStatCycleItems (string cycleId, IEnumerable< string > statCodes, ResultCallback< PagedStatCycleItem > callback, int limit=20, int offset=0)
	Get user's own statistic cycle item.

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

Member Function Documentation

BulkFetchStatItemsValue()

void AccelByte.Api.Statistic.BulkFetchStatItemsValue ( string statCode, string[] userIds, ResultCallback< FetchUserStatistic > callback )

inline

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

Parameters

statCode	This is the StatCode that will be stored in the slot.
userIds	This is the UserId array that will be stored in the slot.
callback	Returns an array of FetchUserStatistic via callback when completed

CreateUserStatItems()

void AccelByte.Api.Statistic.CreateUserStatItems ( CreateStatItemRequest[] statItems, ResultCallback< StatItemOperationResult[]> callback )

inline

Create stat items of a user. Before a user can have any data in a stat item, he/she needs to have that stat item created.

Parameters

statItems	List of statCodes to be created for a user
callback	Returns all profile's StatItems via callback when completed

GetAllUserStatItems()

void AccelByte.Api.Statistic.GetAllUserStatItems ( ResultCallback< PagedStatItems > callback, int offset = 0, int limit = 20, StatisticSortBy sortBy = StatisticSortBy::UpdatedAtAsc )

inline

Get all stat items of a user.

Parameters

callback	Returns all profile's StatItems via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional, default = 20)
sortBy	The sorting method of item on page (optional, default = updated at and ascending)

GetGlobalStatItemsByStatCode()

void AccelByte.Api.Statistic.GetGlobalStatItemsByStatCode ( string statCode, ResultCallback< GlobalStatItem > callback )

inline

Get global statistic item by statistic code.

Parameters

statCode	StatCode.
callback	Returns GlobalStatItem via callback when completed

GetListStatCycleConfigs()

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

inline

Get the list of statistic cycle configuration data that belongs to the current namespace.

Parameters

callback	Returns PagedStatCycleConfigs via callback
type	Statistic cycle type
status	Statistic cycle status
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)

GetListUserStatCycleItem()

void AccelByte.Api.Statistic.GetListUserStatCycleItem ( string cycleId, ResultCallback< PagedStatCycleItem > callback, int offset = 0, int limit = 20, string[] statCodes = null )

inline

Get list of user's statistic cycle item.

Parameters

cycleId	The cycle id where the statistic item belongs to
callback	Returns PagedStatCycleItem via callback
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)
statCodes	List of specific stat codes to be retrieved. Optional

GetMyStatCycleItems() [1/3]

void AccelByte.Api.Statistic.GetMyStatCycleItems ( string cycleId, GetMyStatCycleItemsOptionalParam optionalParam, ResultCallback< PagedStatCycleItem > callback )

inline

Get user's own statistic cycle item.

Parameters

cycleId	The cycle id to which the stat item belong
optionalParam	Optional parameter be sent
callback	Returns PagedStatCycleItem via callback

GetMyStatCycleItems() [2/3]

void AccelByte.Api.Statistic.GetMyStatCycleItems ( string cycleId, IEnumerable< string > statCodes, ResultCallback< PagedStatCycleItem > callback, int limit = 20, int offset = 0 )

inline

Get user's own statistic cycle item.

Parameters

cycleId	The cycle id to which the stat item belong
statCodes	Array of statistic codes for statistic cycle items to be retrieved
callback	Returns PagedStatCycleItem via callback
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)

GetMyStatCycleItems() [3/3]

void AccelByte.Api.Statistic.GetMyStatCycleItems ( string cycleId, ResultCallback< PagedStatCycleItem > callback )

inline

Get user's own statistic cycle item.

Parameters

cycleId	The cycle id to which the stat item belong
callback	Returns PagedStatCycleItem via callback

GetMyStatItems() [1/3]

void AccelByte.Api.Statistic.GetMyStatItems ( GetMyStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback )

inline

Get user's own statistic item.

Parameters

optionalParam	Optional Parameters to be sent
callback	Returns PagedStatItems via callback

GetMyStatItems() [2/3]

void AccelByte.Api.Statistic.GetMyStatItems ( IEnumerable< string > statCodes, IEnumerable< string > tags, ResultCallback< PagedStatItems > callback, int limit = 20, int offset = 0 )

inline

Get user's own statistic item.

Parameters

statCodes	Array of statistic codes to be retrieved
tags	Array of tags which the statistic items to be retrieved have
callback	Returns PagedStatItems via callback
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)

GetMyStatItems() [3/3]

void AccelByte.Api.Statistic.GetMyStatItems ( ResultCallback< PagedStatItems > callback )

inline

Get user's own statistic item.

Parameters

callback

Returns PagedStatItems via callback

GetMyStatItemValues()

void AccelByte.Api.Statistic.GetMyStatItemValues ( string[] statCodes, string[] tags, string additionalKey, ResultCallback< FetchUser[]> callback )

inline

Get user's own statistic value.

Parameters

statCodes	Array of statistic codes of statistic value to be retrieved
tags	Array of tags that statistic item to be retrieved has
additionalKey
callback	Returns FetchUser[] via callback

GetStatCycleConfig()

void AccelByte.Api.Statistic.GetStatCycleConfig ( string cycleId, ResultCallback< StatCycleConfig > callback )

inline

Get statistic cycle configuration data.

Parameters

cycleId	The id of the config data
callback	Returns StatCycleConfig via callback

GetUserStatItems() [1/5]

void AccelByte.Api.Statistic.GetUserStatItems ( GetUserStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback )

inline

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

Parameters

optionalParam	Optional parameters to be sent
callback	>Returns all profile's StatItems via callback when completed

GetUserStatItems() [2/5]

void AccelByte.Api.Statistic.GetUserStatItems ( 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

statCodes	List of statCodes that will be included in the result
tags	List of tags that will be included in the result
callback	Returns all profile's StatItems via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional, default = 20)
sortBy	The sorting method of item on page (optional, default = updated at and ascending)

GetUserStatItems() [3/5]

void AccelByte.Api.Statistic.GetUserStatItems ( ResultCallback< PagedStatItems > callback )

inline

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

Parameters

callback

Returns all profile's StatItems via callback when completed

GetUserStatItems() [4/5]

void AccelByte.Api.Statistic.GetUserStatItems ( string targetUserId, GetUserStatItemsOptionalParam optionalParam, ResultCallback< PagedStatItems > callback )

inline

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

Parameters

targetUserId	target user to be queried
optionalParam	Optional parameters to be sent
callback	Returns target user StatItems via callback when completed

GetUserStatItems() [5/5]

void AccelByte.Api.Statistic.GetUserStatItems ( string targetUserId, ResultCallback< PagedStatItems > callback )

inline

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

Parameters

targetUserId	target user to be queried
callback	Returns target user StatItems via callback when completed

IncrementUserStatItems()

void AccelByte.Api.Statistic.IncrementUserStatItems ( StatItemIncrement[] increments, ResultCallback< StatItemOperationResult[]> callback )

inline

Update stat items for a users.

Parameters

increments	Consist of one or more statCode with its increament value. Positive increament value means it will increase the previous statCode value. Negative increament value means it will decrease the previous statCode value.
callback	Returns an array of BulkStatItemOperationResult via callback when completed

ListUserStatItems()

void AccelByte.Api.Statistic.ListUserStatItems ( string[] statCodes, string[] tags, string additionalKey, ResultCallback< FetchUser[]> callback )

inline

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

statCodes	StatCodes
tags	This is the Tag array that will be stored in the slot.
additionalKey	This is the AdditionalKey that will be stored in the slot.
callback	Returns an array of FetchUser via callback when completed

ResetUserStatItems()

void AccelByte.Api.Statistic.ResetUserStatItems ( StatItemReset[] resets, ResultCallback< StatItemOperationResult[]> callback )

inline

Reset stat items for a user.

Parameters

resets	Consist of one or more statCode.
callback	Returns an array of BulkStatItemOperationResult via callback when completed

UpdateUserStatItems() [1/2]

void AccelByte.Api.Statistic.UpdateUserStatItems ( StatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback )

inline

Update stat items with the specified update strategy for a user.

Parameters

updates

Consist 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.

callback

Returns an array of BulkStatItemOperationResult via callback when completed

UpdateUserStatItems() [2/2]

void AccelByte.Api.Statistic.UpdateUserStatItems ( string additionalKey, StatItemUpdate[] updates, ResultCallback< StatItemOperationResult[]> callback )

inline

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

Parameters

additionalKey	To identify multi level user statItem, such as character
updates	Consist 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.
callback	Returns an array of BulkStatItemOperationResult via callback when completed

UpdateUserStatItemsValue()

void AccelByte.Api.Statistic.UpdateUserStatItemsValue ( string statCode, string additionalKey, PublicUpdateUserStatItem updateUserStatItem, ResultCallback< UpdateUserStatItemValueResponse > callback )

inline

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

Parameters

statCode	StatCode.
additionalKey	This is the AdditionalKey that will be stored in the slot.
updateUserStatItem	This is the UpdateUserStatItem that will be stored in the slot.
callback	Returns an array of UpdateUserStatItemValueResponse via callback when completed