Beamable.Server.Api.Stats.IMicroserviceStatsApi Interface Reference

This type defines the Microservice main entry point for the Stats feature. More...

Inheritance diagram for Beamable.Server.Api.Stats.IMicroserviceStatsApi:

Collaboration diagram for Beamable.Server.Api.Stats.IMicroserviceStatsApi:

Public Member Functions
Promise< string >	GetProtectedPlayerStat (long userId, string key)
	Retrieve a stat value, by key More...
Promise< Dictionary< string, string > >	GetProtectedPlayerStats (long userId, string[] stats)
	Retrieve one or more stat values, each by key More...
Promise< Dictionary< string, string > >	GetAllProtectedPlayerStats (long userId)
	Retrieve all stat values, each by key More...
Promise< EmptyResponse >	SetProtectedPlayerStat (long userId, string key, string value)
	Set a stat value, by key More...
Promise< EmptyResponse >	SetProtectedPlayerStats (long userId, Dictionary< string, string > stats)
	Set one or more stat values, by key More...
Promise< EmptyResponse >	SetStats (string domain, string access, string type, long userId, Dictionary< string, string > stats)
Promise< Dictionary< string, string > >	GetStats (string domain, string access, string type, long userId, string[] stats)
Promise< StatsSearchResponse >	SearchStats (string domain, string access, string type, List< Criteria > criteria)
	Queries the player base for matches against specific stats defined by the given criteria . More...
Public Member Functions inherited from Beamable.Common.Api.Stats.IStatsApi
UserDataCache< Dictionary< string, string > >	GetCache (string prefix)
	Get the UserDataCache<T> for the stat prefix More...
Promise< EmptyResponse >	SetStats (string access, Dictionary< string, string > stats)
	Set the current player's client player stats. More...
Promise< Dictionary< string, string > >	GetStats (string domain, string access, string type, long id)
	Get all of the stats for a given player id More...

Detailed Description

This type defines the Microservice main entry point for the Stats feature.

Related Links

• See the Stats feature documentation
• See Beamable.Server.IBeamableServices script reference

Member Function Documentation

GetAllProtectedPlayerStats()

Promise< Dictionary< string, string > > Beamable.Server.Api.Stats.IMicroserviceStatsApi.GetAllProtectedPlayerStats

(

long

userId

)

Retrieve all stat values, each by key

Parameters

userId

Returns

GetProtectedPlayerStat()

Promise< string > Beamable.Server.Api.Stats.IMicroserviceStatsApi.GetProtectedPlayerStat	(	long	userId,
		string	key
	)

Retrieve a stat value, by key

Parameters

userId
key

Returns

GetProtectedPlayerStats()

Promise< Dictionary< string, string > > Beamable.Server.Api.Stats.IMicroserviceStatsApi.GetProtectedPlayerStats	(	long	userId,
		string[]	stats
	)

Retrieve one or more stat values, each by key

Parameters

userId
stats

Returns

SearchStats()

Promise< StatsSearchResponse > Beamable.Server.Api.Stats.IMicroserviceStatsApi.SearchStats	(	string	domain,
		string	access,
		string	type,
		List< Criteria >	criteria
	)

Queries the player base for matches against specific stats defined by the given criteria .

Parameters

domain	"game" or "player".
access	"public" or "private"
type	Should always be "player" (exists for legacy reasons).
criteria	List of all Criteria that must match.

Returns

The list of DBIDs for all users that match ALL of the criteria provided.

SetProtectedPlayerStat()

Promise< EmptyResponse > Beamable.Server.Api.Stats.IMicroserviceStatsApi.SetProtectedPlayerStat	(	long	userId,
		string	key,
		string	value
	)

Set a stat value, by key

Parameters

userId
key
value

Returns

SetProtectedPlayerStats()

Promise< EmptyResponse > Beamable.Server.Api.Stats.IMicroserviceStatsApi.SetProtectedPlayerStats	(	long	userId,
		Dictionary< string, string >	stats
	)

Set one or more stat values, by key

Parameters

userId
stats

Returns

---

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

• com.beamable.server/SharedRuntime/Api/Stats/IMicroserviceStatsApi.cs