Beamable SDK
Public Member Functions | Properties | List of all members
Beamable.Common.Api.CloudData.CloudDataApi Class Reference

This type defines the Client main entry point for the A/B Testing feature. More...

Inheritance diagram for Beamable.Common.Api.CloudData.CloudDataApi:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Common.Api.CloudData.CloudDataApi:
Collaboration graph
[legend]

Public Member Functions

 CloudDataApi (IUserContext ctx, IBeamableRequester requester)
 
Promise< GetCloudDataManifestResponseGetGameManifest ()
 This method will return the cloud data for the entire game. It cannot be called by a player. You must be an admin user to execute this method. More...
 
Promise< GetCloudDataManifestResponseGetPlayerManifest ()
 Get the current player's cloud trial data. The GetCloudDataManifestResponse will include data for the player's assigned cohorts. Remember, if that list is empty, it may be because the cohorts only work for game.private stats conditions. More...
 

Properties

IUserContext Ctx [get]
 
IBeamableRequester Requester [get]
 

Detailed Description

This type defines the Client main entry point for the A/B Testing feature.

Related Links

img beamable-logo

Member Function Documentation

◆ GetGameManifest()

Promise< GetCloudDataManifestResponse > Beamable.Common.Api.CloudData.CloudDataApi.GetGameManifest ( )
inline

This method will return the cloud data for the entire game. It cannot be called by a player. You must be an admin user to execute this method.

Returns

Implements Beamable.Common.Api.CloudData.ICloudDataApi.

◆ GetPlayerManifest()

Promise< GetCloudDataManifestResponse > Beamable.Common.Api.CloudData.CloudDataApi.GetPlayerManifest ( )
inline

Get the current player's cloud trial data. The GetCloudDataManifestResponse will include data for the player's assigned cohorts. Remember, if that list is empty, it may be because the cohorts only work for game.private stats conditions.

Returns
A GetCloudDataManifestResponse promise representing the player's cloud trial data.

Implements Beamable.Common.Api.CloudData.ICloudDataApi.


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