Sections: Welcome | Script Reference | Unity SDK Features | UNREAL SDK FEATURES | Beam CLI | Cloud Services | Identity | Profile & Storage | Game Economy | Live Ops | Social & Networking | Business Intelligence | Developer Tools | Integrations | Marketplace | Portal | Game Content Designer | Samples | Migration | Learning | Appendix | Dependency Injection | Service Registration | Factory Function | Inferred Generics | Service Resolution | Circular Dependencies | IDependencyProvider is always available! Welcome Beamable Documentation Installing Beamable (Unity) Installing Beamable (Unreal) Support Tiers Script Reference Client C# API Server REST API Unity SDK Features Getting Started Builds & Environments Beamable Player Centric API Player Centric API - Overview Player Centric API - Code Player Centric API - Lifecycle Functions Dependency Injection Dependency Service Lifecycle Custom Services Microservices Autogenerated SDK Offline Mode Lightbeam Samples LightBeam Overview Account Management UNREAL SDK FEATURES Getting Started Runtime Concepts Unreal User Guide Beam CLI Beam CLI Commands Project Ps Project Add-unreal-project Content Reset Init Project Share-code Services Upload-api Config Secret Project Logs Services Reset Services Manifests Config Set Content Publish Services Enable Project Add Project Services Service-metrics Project New Storage Me Content Services Ps Services Run Login Org Services Service-logs Project New Content Open Oapi Services Promote Config Project Open-mongo Project Open-swagger Project Add-unity-project Services Register Content Pull Oapi Download Services Modify Content Status Services Templates Services Registry Org New Version Project Generate-ignore-file Version List Version Install Services Get-connection-string Project Update-unity-beam-package Services Stop Content Tag Content Tag Rm Content Tag Add Content Bulk-edit Project Build Config Realm Project Dependencies Listen Server Project Oapi Project Regenerate Listen Project Version Project Deps Listen Player Project Run Project New Service Project Deps Add Config Realm Remove Project Deps List Project New Common-lib Config Realm Set Project List Project Stop Services Reset Container Project Generate-properties Project Deps Remove Services Reset Image Federation Disable Federation Federation Set Federation Add Project Group Deployment Status Portal Player Deployment Plan Federation Local-key Deployment Release Federation Local-settings Get Project Storage Temp Clear Logs Federation Enable Logout Federation List Deployment Get Deployment List Temp Clear Server Ps Unity Manifest Deployment Federation Remove Token New-guest Project Storage Erase Token From-refresh Project Disable Temp Token List Project Storage Snapshot Federation Local-settings Set IFederatedGameServer Token Inspect Federation Local-settings Get IFederatedGameServer Portal Project Group Rm Services Docker Status Project Open Federation Local-settings Project Enable Services Docker Start Project Remove Unity Restore Server Clear Federation Local-settings Set Services Build Project Group Add Project Storage Restore Services Docker Federation Local-settings Set IFederatedGameServer Federation Local-settings Get IFederatedGameServer Federation Local-settings Set IFederatedGameServer Federation Local-settings Get IFederatedGameServer Federation Local-settings Get IFederatedGameServer Unreal Select-sample Federation Local-settings Set IFederatedGameServer Federation Local-settings Set IFederatedGameServer Federation Local-settings Get IFederatedGameServer Federation Local-settings Get IFederatedGameServer Checks Scan Checks Federation Local-settings Set IFederatedGameServer Federation Local-settings Set IFederatedGameServer Federation Local-settings Get IFederatedGameServer Grafana Stop Content Replace-local Collector Start Content Sync Content Save Grafana Ps Collector Status Org Realms Content Ps Collector Stop Collector Get Collector Content Resolve Federation Local-settings Get IFederatedGameServer Project Generate-client-oapi Grafana Open Federation Local-settings Set IFederatedGameServer Federation Local-settings Set IFederatedGameServer Federation Local-settings Get IFederatedGameServer Content Restore Content Snapshot Telemetry Telemetry Logs Config Routes Developer-user-manager Content Snapshot-list Telemetry Set-config Content Archive-manifest Content List-manifests Project Add-paths Developer-user-manager Create-user Content New-manifest Developer-user-manager Update-info Developer-user-manager Ps Telemetry Push Telemetry Collector Get Org Games Project Generate Telemetry Collector Telemetry Collector Start Developer-user-manager Copy-state Developer-user-manager Remove-user Telemetry Config Project Generate Web-client Telemetry Collector Stop Federation Local-settings Get IFederatedGameServer Telemetry Prune Developer-user-manager Create-user-batch Federation Local-settings Set IFederatedGameServer Telemetry Collector Ps Developer-user-manager Clean-captured-user-buffer Content Tag Set Developer-user-manager Save-user Federation Local-settings Get IFederatedGameServer Federation Local-settings Set IFederatedGameServer Guides Getting Started Configuration Upgrading Notifications Microservices Microservice Deployment Microservice Debugging Microservice Configuration Microservice Routing Microservice Storage MIcroservice Federation Microservice CLI Workflows Microservice UPM Command Line Outout Microservice Telemetry Microservice Logging Cloud Services Microservices Microstorages Scheduled Jobs Unity Getting Started Calling Microservices from Unity Publishing Shared Code Sharing Microservices between Projects Identity Identity Frictionless Authentication Frictionless - Overview Frictionless - Guide Frictionless - Code Username / Password Username / Password - Overview Username / Password - Code Facebook Sign-In Facebook Sign-In - Overview Facebook Sign-In - Code Facebook's Data Protection Assessment Google Sign-In Google Sign-In - Overview Google Sign-In - Code Apple Sign-In Apple Sign-In - Overview Apple Sign-In - Code Apple's App Privacy Questionnaire Steam Integration Steam Integration - Overview Steam Integration - Guide Extending Identity Adding HTML Sign-In Federated Identity Google Play Game Services Sign-In Google Play Game Services Sign-In - Overview Google Play Game Services Sign-In - Code Profile & Storage Profile & Storage Cloud Save Cloud Save - Overview Player Cloud Save - Code Cloud Save - Code Content Content - Overview Content - Guide Content - Code Content - Custom Content Content - Remote Configuration Content - Validation Content - Tool Window Content - Filtering Stats Stats - Overview Stats - Guide Stats - Code Game Economy Inventory Inventory - Overview Inventory - Code Inventory - Extending with Federation Inventory - Pruning Deprecated Items Stores Stores - Overview Stores - Code Stores - Custom Purchaser Stores - Custom Stores Custom Purchase Reporting Stores - In-App Purchasing (Android) Virtual Currency Virtual Currency - Overview Virtual Currency - Code Live Ops Live Ops Live Ops Prefabs Live Ops Prefabs - Overview Announcements - Prefab Events Events - Overview Events - Guide Events - Code Announcements Announcements - Overview Announcements - Code Notifications Notifications - Overview Notifications - Code Mail Mail - Overview Mail - Code Player Stats and Activities Social & Networking Social & Networking Chat Chat - Overview Chat - Code Connectivity Connectivity - Overview Connectivity - Code Connectivity - Code - Reduce NoConnectivityException Friends Friends - Overview Friends - Code Groups Groups - Overview Groups - Code Leaderboards Leaderboards - Overview Leaderboards - Code Matchmaking Matchmaking - Overview Matchmaking - Guide Matchmaking - Code Multiplayer Multiplayer - Overview Multiplayer - Guide Multiplayer - Code Parties Parties - Overview Parties - Code Lobbies Lobbies - Overview Lobbies - Code Tournaments Tournaments - Overview Tournaments - Code Business Intelligence Business Intelligence Telemetry Telemetry - Overview Telemetry - Code Analytics Analytics - Overview Analytics - Guide Analytics - Code Segmentation Segmentation - Overview Segmentation - Guide A/B Testing A/B Testing - Overview A/B Testing - Guide A/B Testing - Code Developer Tools Unity Beam Library Beam Services Unity Editor Login Content Manager Admin Admin - Overview Admin - Prefab Admin - Code Integrations Integrating WebGL Marketplace Amplitude Integration Edgegap Goplay Integration Harbor Hathora Cloud Integration Idem Multiplayer Matchmaking API Mixpanel Integration Photon Fusion Polygon Integration Scenario Integration Solana Integration SUI Integration Theta Network Integration Venly Integration Zebedee API Zenject Integration COMING SOON Common Sense Machines: Coder Cardano Blockchain Integration Halliday Integration Hero Trainer Integration Lamina1 Integration LAOS Network Integration Thirdwave Wallet Intelligence Portal Portal - Overview Adding Developers Granting Developer Permissions Announcements Campaigns Cloud Data Groups In-App Purchases Inventory Leaderboards Notify All Players Players Stats Tournaments Game Content Designer Game Content Designer Samples Samples Chat (GPW) Chat (GPW) - Overview Chat (GPW) - Guide Chat & MicroStorage (GPW2) Chat & MicroStorage (GPW2) - Overview Chat & MicroStorage (GPW2) - Guide Leaderboard (ABC) Leaderboard (ABC) - Overview Leaderboard (ABC) - Guide Microservices (BBB) Microservices (BBB) - Overview Microservices (BBB) - Guide Multiplayer (HATS) Multiplayer (HATS) - Overview Multiplayer (HATS) - Guide Multiplayer (KOR) Multiplayer (KOR) - Overview Multiplayer (KOR) - Guide Multiplayer (TBF) Multiplayer (TBF) - Overview Multiplayer (TBF) - Guide Photon Multiplayer (RLGL) Photon Multiplayer (RLGL) - Overview Photon Multiplayer (RLGL) - Guide SDK Examples Game Type Matchmaking Account Deletion Asynchronous Turn Based Notifications API Examples Beamable Web Access Example Building a Battle Pass Migration Migrating Unity from 1.19.23 to 2.0.0 GameSparks Migration Migrating Unity from 2.x to 3.0 Learning Learning Fundamentals Prototyping With Unity Game Jams With Unity Appendix Pricing Best Practices for Pricing Use Cases Glossary Security Overview Performance & Scalability Overview Powered by Dependency Injection How to register and resolve services The Beamable SDK uses a dependency injection approach to organize code layers and services. Every BeamContext is assigned an isolated dependency scope. A dependency scope is a logical group of services. If there are multiple BeamContext instances, then each has a unique dependency scope, and there are no inter-dependencies between the two contexts. Beamable dependency injection is broken up into two main phases, registration , and resolution . The registration phase happens once as the BeamContext is initializing, and the resolution phase happens continously as the game plays. Service Registration All services that will exist must be explicitly registered before the service scope may be used to create any service instances . The IDependencyBuilder interface is the root type used for service registration in the Beamable SDK. A service registration has 4 key elements, The public type of the service (often, an interface type) The private type of the service (often, an implementation class of the interface). The private type must be assignable to the public type. A service type of Singleton , Scoped , or Transient A factory function that can map an instance of IDependencyProvider to an instance of the registration's private type. The IDependencyBuilder has methods, AddSingleton , AddScoped , and AddTransient that add service registrations. There are overloads of these methods that have various levels of syntactic sugar for providing the 4 key elements of a service registration. The following code snippet is the most verbose way to register a singleton service. C# // the public type is 'TInterface' // the private type is 'TImpl' // the service type is a Singleton // the factory function is provider => new TImpl() builder.AddSingleton( provider => new TImpl() ); Beamable's service registration happens in the Beamable.Beam.cs class. You can modify the service registration records before any BeamContext is created by using custom services . Factory Function The factory function is often unnecessary to provide. The dependency injection system can automatically create factory functions for services that either, have no constructor or have parameterless constructors, or have constructor parameter types that are all registered in the IDependencyBuilder as public types. For example, the previous example can be written without specifying the factory function, like so, C# builder.AddSingleton(); The system can also create factory functions for services that have constructors that only have parameter types represented as public types in the IDependencyBuilder . For example, consider the following class, TunaService ... C# public class TunaService : ITunaService { private readonly TInterface _dep; // the constructor requires a `TInterface` instance public TunaService(TInterface dep) { _dep = dep; } } The constructor of TunaService requires a TInterface , which is already a registered service. TInterface and TunaService can be registered like so, C# builder.AddSingleton(); builder.AddSingleton(); In practice, it is uncommon that the factory function must be specified. However, there are absolutely cases where it is required or preferred. For example, imagine a third class to add to the service scope, FishSticks , that requires a simple bool configuration, C# public class FishSticks : IFishSticks { private readonly bool _frozen; private readonly ITunaService _tuna; public FishSticks(ITunaService tuna, bool frozen) { _frozen = frozen; _tuna = tuna; ] } The bool type is not registered in the IDependencyBuilder , and cannot be, because it is a primitive type. In this scenario, the factory function must be specified. The ITunaService parameter can be resolved using the factory function's IDependencyProvider argument, C# builder.AddSingleton(); builder.AddSingleton(); builder.AddSingleton(provider => new FishSticks(provider.GetService(), true)); A second common reason to specify a factory function is to register a single instance as the implementation service for multiple interface types. For example, imagine we have a class TunaFishSticks that implements both ITunaService , and IFishSticks , C# public class TunaFishSticks : ITunaService, IFishSticks { public TunaFishSticks() { } } If the registrations were written as below, then there would be 2 instances of TunaFishSticks , the instance that backs the ITunaService interface, and the instance that backs the IFishSticks service. C# builder.AddSingleton(); builder.AddSingleton(); builder.AddSingleton(); However, the following configuration will allow a single instance of TunaFishSticks to back both types. C# builder.AddSingleton(); builder.AddSingleton(p => p.GetService()); builder.AddSingleton(p => p.GetService()); builder.AddSingleton(); Inferred Generics The service registration must have a public interface type, and a private implementation type that is assignable to the public interface type. However, one or the other is often inferable given the context. If the interface type and the implementation type are the same, then it only needs to be specified once. For example, imagine the class, WidgetService C# public class WidgetService { } The type has no interface, and is going to be referenced directly as WidgetSource . C# builder.AddSingleton(); Service Resolution The IDependencyBuilder can be built into a IDependencyProvider instance, which represents the actual service scope. C# IDependencyProvider provider = builder.Build(); The IDependencyProvider is given all the service registrations from the IDependencyBuilder . Instead of allowing more services to. be registered, the IDependencyProvider allows services to be instantiated. For example, imagine that a type ITunaService was registered, then an instance could be acquired like this, C# var tunaService = provider.GetService(); The GetService() function does not allow for any configuration to be given. The exact mechanism of the instantiation is hidden and cannot be altered. If there is configuration that needs to be given, it should have been configured in the registration phase. Services are created lazily. If a service is registered in the dependency scope, but no code ever requires an instance of the service, then the service is never instantiated. Depending on the type of service , the GetService() invocation will either create an instance, or use a previously cached instance of the requested service. The IDependencyProvider has two other main functions, CanBuildService , and Fork . The CanBuildService function will return true of false depending on if the given scope is able to construct the requested type. The Fork function will fork the current scope and create a child scope. In the example above, tunaService is actually an IDependencyProviderScope , which is the type that implements IDependencyProvider . The IDependencyProviderScope provides access to the service registration records, and parent/child scope information. Usually, the full control of IDependencyProviderScope is not required. The Beamable SDK creates a IDependencyProviderScope for every BeamContext instance. The IDependencyProvider is available from the ServiceProvider property

What it does

Available capabilities

Tags

Ways to use it