This interface represents a collection of Beamable APIs and data structures. This type defines the Client main entry point for the main Beamable features. More...

Inheritance diagram for Beamable.IBeamableAPI:

[legend]

Public Member Functions
void	UpdateUserData (User user)
	Given a User, update the authorized user for this player instance. This will trigger the OnUserChanged event. More...

Promise< ISet< UserBundle > >	GetDeviceUsers ()
	Get a user of UserBundle objects that represent stored Users on the current device, but that aren't the active player. When a player manages multiple Users on one device, the IAccessTokens for the other users are stored on the device. More...

void	RemoveDeviceUser (TokenResponse token)
	Remove a stored UserBundle from the stored device users. When a player manages multiple Users on one device, the IAccessTokens for the other users are stored on the device. More...

void	ClearDeviceUsers ()
	Remove all stored UserBundles from the device. More...

Promise< Unit >	ApplyToken (TokenResponse response)
	Given a TokenResponse, update the authorized user for this player instance. This will trigger the logging out event, the reload user, and the logging in event. More...

Properties
User	User `[get]`
	The currently signed in User for this IBeamableAPI instance.

AccessToken	Token `[get]`
	The AccessToken for the User object's account.

IExperimentalAPI	Experimental `[get]`
	Access experimental features of Beamable. Services from this accessor may be subject to change

AnnouncementsService	AnnouncementService `[get]`
	Access the AnnouncementService for this player instance.

IAuthService	AuthService `[get]`
	Access the IAuthService for this player instance.

CloudSavingService	CloudSavingService `[get]`
	Access the CloudSavingService for this player instance.

ContentService	ContentService `[get]`
	Access the ContentService for this player instance.

InventoryService	InventoryService `[get]`
	Access the InventoryService for this player instance.

LeaderboardService	LeaderboardService `[get]`
	Access the LeaderboardService for this player instance.

IBeamableRequester	Requester `[get]`
	Access the IBeamableRequester for this player instance.

StatsService	StatsService `[get]`
	Access the StatsService for this player instance.

StatsService	Stats `[get]`

SessionService	SessionService `[get]`
	Access the SessionService for this player instance.

IAnalyticsTracker	AnalyticsTracker `[get]`
	Access the IAnalyticsTracker for this player instance.

MailService	MailService `[get]`
	Access the MailService for this player instance.

PushService	PushService `[get]`
	Access the PushService for this player instance.

CommerceService	CommerceService `[get]`
	Access the CommerceService for this player instance.

PaymentService	PaymentService `[get]`
	Access the PaymentService for this player instance.

GroupsService	GroupsService `[get]`
	Access the GroupsService for this player instance.

EventsService	EventsService `[get]`
	Access the EventsService for this player instance.

Promise< IBeamablePurchaser >	BeamableIAP `[get]`
	A Promise<IBeamablePurchaser> that contains the IBeamablePurchaser. If UNITY_IAP has been enabled, this promise will complete and grant an instance of the IBeamablePurchaser to use to make purchase.

IConnectivityService	ConnectivityService `[get]`
	Access the IConnectivityService for this player instance.

INotificationService	NotificationService `[get]`
	Access the INotificationService for this player instance.

ITournamentApi	TournamentsService `[get]`
	Access the ITournamentApi for this player instance.

ICloudDataApi	TrialDataService `[get]`
	Access the ICloudDataApi for this player instance.

ITournamentApi	Tournaments `[get]`
	Obsolete, please use the TournamentsService property instead.

ISdkEventService	SdkEventService `[get]`
	Access the ISdkEventService for this player instance.

Events
Action< User >	OnUserChanged
	An event that will trigger anytime the User for this IBeamableAPI instance changes. It can change due to user log out, log in, account switch, or whenever a user attaches a new credential to their account.

Action< User >	OnUserLoggingOut
	An event that will trigger anytime the User for this IBeamableAPI instance logs out.

Detailed Description

This interface represents a collection of Beamable APIs and data structures. This type defines the Client main entry point for the main Beamable features.

Member Function Documentation

◆ ApplyToken()

Promise< Unit > Beamable.IBeamableAPI.ApplyToken ( TokenResponse response )

Given a TokenResponse, update the authorized user for this player instance. This will trigger the logging out event, the reload user, and the logging in event.

Parameters

response A valid TokenResponse. The tokens will be the identify for the new user.

Returns: A Promise representing when the update has finished.

Implemented in Beamable.Player.ApiServices.

◆ ClearDeviceUsers()

void Beamable.IBeamableAPI.ClearDeviceUsers ( )

Remove all stored UserBundles from the device.

Implemented in Beamable.Player.ApiServices.

◆ GetDeviceUsers()

Promise< ISet< UserBundle > > Beamable.IBeamableAPI.GetDeviceUsers ( )

Get a user of UserBundle objects that represent stored Users on the current device, but that aren't the active player. When a player manages multiple Users on one device, the IAccessTokens for the other users are stored on the device.

Returns: A Promise containing a set of UserBundles representing other stored users available on the device.

Implemented in Beamable.Player.ApiServices.

◆ RemoveDeviceUser()

void Beamable.IBeamableAPI.RemoveDeviceUser ( TokenResponse token )

Remove a stored UserBundle from the stored device users. When a player manages multiple Users on one device, the IAccessTokens for the other users are stored on the device.

Parameters

token A valid TokenResponse for the player to remove.

Implemented in Beamable.Player.ApiServices.

◆ UpdateUserData()

void Beamable.IBeamableAPI.UpdateUserData ( User user )

Given a User, update the authorized user for this player instance. This will trigger the OnUserChanged event.

Parameters

user A User

Implemented in Beamable.Player.ApiServices.

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

com.beamable/Runtime/API.cs

Public Member Functions

Properties

Events

Detailed Description

Related Links

Member Function Documentation

◆ ApplyToken()

◆ ClearDeviceUsers()

◆ GetDeviceUsers()

◆ RemoveDeviceUser()

◆ UpdateUserData()