This class defines the main entry point for the main Beamable features. More...
Inheritance diagram for Beamable.API:
Collaboration diagram for Beamable.API:
Public Member Functions | |
| Promise< Unit > | ApplyToken (TokenResponse tokenResponse) |
| Promise< ISet< UserBundle > > | GetDeviceUsers () |
| void | RemoveDeviceUser (TokenResponse token) |
| void | UpdateUserData (User user) |
| void | TearDown () |
Public Attributes | |
| AnnouncementsService | AnnouncementService => _platform.Announcements |
| Entry point for the Announcements feature. More... | |
| ContentService | ContentService => _platform.ContentService |
| Entry point for the Content feature. More... | |
| InventoryService | InventoryService => _platform.Inventory |
| Entry point for the Inventory feature. More... | |
| LeaderboardService | LeaderboardService => _platform.Leaderboard |
| Entry point for the Leaderboards feature. More... | |
| IAuthService | AuthService => _platform.Auth |
| Entry point for the Accounts feature. More... | |
| IAnalyticsTracker | AnalyticsTracker => _platform.Analytics |
| Entry point for the Analytics feature. More... | |
| StatsService | StatsService => _platform.Stats |
| Entry point for the Analytics feature. More... | |
| StatsService | Stats => StatsService |
| Obsolete. Use StatsService instead. More... | |
| ITournamentApi | TournamentsService => _platform.Tournaments |
| Entry point for the Tournaments feature. More... | |
| ITournamentApi | Tournaments => TournamentsService |
| Obsolete. Use TournamentsService instead. More... | |
| SessionService | SessionService => _platform.Session |
| Entry point for the SessionService. More... | |
| MailService | MailService => _platform.Mail |
| Entry point for the Mail feature. More... | |
| PushService | PushService => _platform.Push |
| Entry point for the PushService. More... | |
| PaymentService | PaymentService => _platform.Payments |
| Entry point for the Store feature. More... | |
| CommerceService | CommerceService => _platform.Commerce |
| Entry point for the Store feature. More... | |
| EventsService | EventsService => _platform.Events |
| Entry point for the Events feature. More... | |
| CloudSavingService | CloudSavingService => _platform.CloudSaving |
| Entry point for the Cloud Saving feature. More... | |
| ICloudDataApi | TrialDataService => _platform.CloudDataService |
| Entry point for the Cloud Saving feature. More... | |
| GroupsService | GroupsService => _platform.Groups |
| Entry point for the Groups feature. More... | |
| PlatformRequester | Requester => _platform.Requester |
| Entry point for the PlatformRequester. More... | |
| Promise< IBeamablePurchaser > | BeamableIAP => _platform.InitializedBeamableIAP |
| Entry point for the IBeamablePurchaser. More... | |
| User | User => _platform.User |
| Entry point for the User. More... | |
| AccessToken | Token => _platform.AccessToken |
| Entry point for the AccessToken. More... | |
| IConnectivityService | ConnectivityService => _platform.ConnectivityService |
| Entry point for the IConnectivityService. More... | |
Properties | |
| static Promise< IBeamableAPI > | Instance [get] |
| IExperimentalAPI | Experimental [get] |
| Entry point for experimental labs / beta features More... | |
 Properties inherited from Beamable.IBeamableAPI | |
| User | User [get] |
| AccessToken | Token [get] |
| IExperimentalAPI | Experimental [get] |
| AnnouncementsService | AnnouncementService [get] |
| IAuthService | AuthService [get] |
| CloudSavingService | CloudSavingService [get] |
| ContentService | ContentService [get] |
| InventoryService | InventoryService [get] |
| LeaderboardService | LeaderboardService [get] |
| PlatformRequester | Requester [get] |
| StatsService | StatsService [get] |
| StatsService | Stats [get] |
| SessionService | SessionService [get] |
| IAnalyticsTracker | AnalyticsTracker [get] |
| MailService | MailService [get] |
| PushService | PushService [get] |
| CommerceService | CommerceService [get] |
| PaymentService | PaymentService [get] |
| GroupsService | GroupsService [get] |
| EventsService | EventsService [get] |
| Promise< IBeamablePurchaser > | BeamableIAP [get] |
| IConnectivityService | ConnectivityService [get] |
| ITournamentApi | TournamentsService [get] |
| ICloudDataApi | TrialDataService [get] |
| ITournamentApi | Tournaments [get] |
Events | |
| Action< User > | OnUserChanged |
| Action< User > | OnUserLoggingOut |
| Events inherited from Beamable.IBeamableAPI | |
| Action< User > | OnUserChanged |
| Action< User > | OnUserLoggingOut |
Detailed Description
This class defines the main entry point for the main Beamable features.
Related Links
- AnalyticsTracker - See Beamable.Api.Analytics.IAnalyticsTracker and Analytics feature.
- AnnouncementsService - See Beamable.Api.Announcements.AnnouncementsService and Announcements feature.
- AuthService - See Beamable.Api.Auth.IAuthService and Accounts feature.
- CommerceService - See Beamable.Api.Commerce.CommerceService and Store feature.
- CloudSavingService - See Beamable.Common.Api.CloudData.ICloudDataApi and Cloud Save feature.
- ContentService - See Beamable.Content.ContentService and Content feature.
- EventsService - See Beamable.Api.Events.EventsService and Events feature.
- GroupsService - See Beamable.Api.Groups.GroupsService and Groups feature.
- InventoryService - See Beamable.Api.Inventory.InventoryService and Inventory feature.
- LeaderboardsService - See Beamable.Api.Leaderboard.LeaderboardService and Leaderboards feature.
- MailService - See Beamable.Api.Mail.MailService and Mail feature.
- PaymentService - See Beamable.Api.Payments.PaymentService and Store feature.
- StatsService - See Beamable.Api.Stats.StatsService and Analytics feature.
- TournamentsService - See Beamable.Common.Api.Tournaments.ITournamentApi and Tournaments feature.
- TrialDataService - See Beamable.Common.Api.CloudData.ICloudDataApi and Cloud Save feature.
Example
This demonstrates example usage.
private async void SetupBeamable()
{
// Example usage
var announcementsService = beamableAPI.AnnouncementsService;
var result = await announcementsService.GetCurrent();
// Others...
var analyticsTracker = beamableAPI.AnalyticsTracker;
var authService = beamableAPI.AuthService;
var cloudSavingService = beamableAPI.CloudSavingService;
var commerceService = beamableAPI.CommerceService;
var connectivityService = beamableAPI.ConnectivityService;
var contentService = beamableAPI.ContentService ;
var eventsService = beamableAPI.EventsService;
var groupsService = beamableAPI.GroupsService;
var inventoryService = beamableAPI.InventoryService;
var leaderboardService = beamableAPI.LeaderboardService;
var mailService = beamableAPI.MailService;
var paymentService = beamableAPI.PaymentService;
var pushService = beamableAPI.PushService;
var sessionService = beamableAPI.SessionService;
var statsService = beamableAPI.StatsService;
var tournamentsService = beamableAPI.TournamentsService;
var trialDataService = beamableAPI.TrialDataService;
}
Member Data Documentation
◆ AnalyticsTracker
| IAnalyticsTracker Beamable.API.AnalyticsTracker => _platform.Analytics |
Entry point for the Analytics feature.
◆ AnnouncementService
| AnnouncementsService Beamable.API.AnnouncementService => _platform.Announcements |
Entry point for the Announcements feature.
◆ AuthService
| IAuthService Beamable.API.AuthService => _platform.Auth |
Entry point for the Accounts feature.
◆ BeamableIAP
| Promise<IBeamablePurchaser> Beamable.API.BeamableIAP => _platform.InitializedBeamableIAP |
Entry point for the IBeamablePurchaser.
◆ CloudSavingService
| CloudSavingService Beamable.API.CloudSavingService => _platform.CloudSaving |
Entry point for the Cloud Saving feature.
◆ CommerceService
| CommerceService Beamable.API.CommerceService => _platform.Commerce |
Entry point for the Store feature.
◆ ConnectivityService
| IConnectivityService Beamable.API.ConnectivityService => _platform.ConnectivityService |
Entry point for the IConnectivityService.
◆ ContentService
| ContentService Beamable.API.ContentService => _platform.ContentService |
Entry point for the Content feature.
◆ EventsService
| EventsService Beamable.API.EventsService => _platform.Events |
Entry point for the Events feature.
◆ GroupsService
| GroupsService Beamable.API.GroupsService => _platform.Groups |
Entry point for the Groups feature.
◆ InventoryService
| InventoryService Beamable.API.InventoryService => _platform.Inventory |
Entry point for the Inventory feature.
◆ LeaderboardService
| LeaderboardService Beamable.API.LeaderboardService => _platform.Leaderboard |
Entry point for the Leaderboards feature.
◆ MailService
| MailService Beamable.API.MailService => _platform.Mail |
Entry point for the Mail feature.
◆ PaymentService
| PaymentService Beamable.API.PaymentService => _platform.Payments |
Entry point for the Store feature.
◆ PushService
| PushService Beamable.API.PushService => _platform.Push |
Entry point for the PushService.
◆ Requester
| PlatformRequester Beamable.API.Requester => _platform.Requester |
Entry point for the PlatformRequester.
◆ SessionService
| SessionService Beamable.API.SessionService => _platform.Session |
Entry point for the SessionService.
◆ Stats
| StatsService Beamable.API.Stats => StatsService |
Obsolete. Use StatsService instead.
◆ StatsService
| StatsService Beamable.API.StatsService => _platform.Stats |
Entry point for the Analytics feature.
◆ Token
| AccessToken Beamable.API.Token => _platform.AccessToken |
Entry point for the AccessToken.
◆ Tournaments
| ITournamentApi Beamable.API.Tournaments => TournamentsService |
Obsolete. Use TournamentsService instead.
◆ TournamentsService
| ITournamentApi Beamable.API.TournamentsService => _platform.Tournaments |
Entry point for the Tournaments feature.
◆ TrialDataService
| ICloudDataApi Beamable.API.TrialDataService => _platform.CloudDataService |
Entry point for the Cloud Saving feature.
◆ User
| User Beamable.API.User => _platform.User |
Entry point for the User.
Property Documentation
◆ Experimental
|
get |
Entry point for experimental labs / beta features
The documentation for this class was generated from the following file:
- client/Packages/com.beamable/Runtime/API.cs
