Class Beamable

A class for wrapping Beamable's server interactions. Interacts with Beamable's API to retrieve and manipulate data on Beamable's servers

Inheritance

Object

Beamable

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public class Beamable : IInjectable

Fields

_actionService

Declaration

protected IActionService _actionService

Field Value

Type	Description
IActionService

_beamableAPI

Declaration

protected IBeamableAPI _beamableAPI

Field Value

Type	Description
IBeamableAPI

_beamableSpecificTypes

Declaration

protected readonly Type[] _beamableSpecificTypes

Field Value

Type	Description
Type[]

_connectionStatusService

Declaration

protected IConnectionStatusService _connectionStatusService

Field Value

Type	Description
IConnectionStatusService

_eventsService

Declaration

protected EventsService _eventsService

Field Value

Type	Description
EventsService

_eventsSubscription

Declaration

protected PlatformSubscription<EventsGetResponse> _eventsSubscription

Field Value

Type	Description
PlatformSubscription<EventsGetResponse>

_inventorySubscription

Declaration

protected PlatformSubscription<InventoryView> _inventorySubscription

Field Value

Type	Description
PlatformSubscription<InventoryView>

_inventoryView

Declaration

protected InventoryView _inventoryView

Field Value

Type	Description
InventoryView

_leaderboardService

Declaration

protected Beamable.Api.Leaderboard.LeaderboardService _leaderboardService

Field Value

Type	Description
Beamable.Api.Leaderboard.LeaderboardService

_refreshingInventory

Declaration

protected bool _refreshingInventory

Field Value

Type	Description
Boolean

DATA

Declaration

public const string DATA = "data"

Field Value

Type	Description
String

FORMATTED_CONTENT_ID

Declaration

protected const string FORMATTED_CONTENT_ID = "{0}.{1}"

Field Value

Type	Description
String

GLOBAL

Declaration

public const string GLOBAL = "global"

Field Value

Type	Description
String

ITEMS

Declaration

public const string ITEMS = "items"

Field Value

Type	Description
String

OnBeamableCallExecuted

Declaration

public Action<bool> OnBeamableCallExecuted

Field Value

Type	Description
Action<Boolean>

Properties

BeamableAPI

Declaration

public virtual IBeamableAPI BeamableAPI { get; }

Property Value

Type	Description
IBeamableAPI

BeamableSpecificTypes

Declaration

public virtual Type[] BeamableSpecificTypes { get; }

Property Value

Type	Description
Type[]

EventsService

Declaration

public EventsService EventsService { get; }

Property Value

Type	Description
EventsService

InventoryView

Declaration

public virtual InventoryView InventoryView { get; }

Property Value

Type	Description
InventoryView

IsLoaded

Declaration

public virtual bool IsLoaded { get; }

Property Value

Type	Description
Boolean

Methods

BeamableNetworkCallException(Exception)

Declaration

public void BeamableNetworkCallException(Exception e)

Parameters

Type	Name	Description
Exception	e

CastToDataProvider(IContentObject)

Declaration

protected virtual IDataProvider CastToDataProvider(IContentObject content)

Parameters

Type	Name	Description
IContentObject	content

Returns

Type	Description
IDataProvider

Cleanup()

Declaration

public virtual void Cleanup()

CreateBeamableConsole()

Declaration

protected virtual void CreateBeamableConsole()

GetContent(String, String)

Declaration

public virtual Task<IContentObject[]> GetContent(string contentTag, string manifestId = "global")

Parameters

Type	Name	Description
String	contentTag
String	manifestId

Returns

Type	Description
Task<IContentObject[]>

GetContentTypePrefix<TType>()

Declaration

public virtual string GetContentTypePrefix<TType>()
    where TType : IContentObject

Returns

Type	Description
String

Type Parameters

Name	Description
TType

HandleEventUpdate(EventsGetResponse)

Declaration

protected virtual void HandleEventUpdate(EventsGetResponse eventsResponse)

Parameters

Type	Name	Description
EventsGetResponse	eventsResponse

HandleInventoryUpdate(InventoryView)

Declaration

protected virtual void HandleInventoryUpdate(InventoryView inventoryView)

Parameters

Type	Name	Description
InventoryView	inventoryView

Initialize(Action)

Declaration

public virtual Task Initialize(Action onComplete)

Parameters

Type	Name	Description
Action	onComplete

Returns

Type	Description
Task

Inject(IResolver)

Declaration

public virtual void Inject(IResolver resolver)

Parameters

Type	Name	Description
IResolver	resolver

LoadContent<TContent>(String)

Declaration

protected virtual Task<IData> LoadContent<TContent>(string contentId)
    where TContent : ContentObject, new()

Parameters

Type	Name	Description
String	contentId

Returns

Type	Description
Task<IData>

Type Parameters

Name	Description
TContent

LoadContentData(String, Action<IDataProvider[]>)

Declaration

public virtual void LoadContentData(string contentTag, Action<IDataProvider[]> onComplete)

Parameters

Type	Name	Description
String	contentTag
Action<IDataProvider[]>	onComplete

LoadContentDataAsync(String, Action<IDataProvider[]>)

Declaration

protected virtual Task LoadContentDataAsync(string contentTag, Action<IDataProvider[]> onComplete)

Parameters

Type	Name	Description
String	contentTag
Action<IDataProvider[]>	onComplete

Returns

Type	Description
Task

LoadContents<TContent>(String[])

Declaration

protected virtual Task<List<IData>> LoadContents<TContent>(string[] ids)
    where TContent : ContentObject, new()

Parameters

Type	Name	Description
String[]	ids

Returns

Type	Description
Task<List<IData>>

Type Parameters

Name	Description
TContent

LoadData(String[], String[], String[], Action<IData[]>)

Declaration

public virtual void LoadData(string[] currencyIds, string[] itemIds, string[] contentIds, Action<IData[]> onDataRetrieved)

Parameters

Type	Name	Description
String[]	currencyIds
String[]	itemIds
String[]	contentIds
Action<IData[]>	onDataRetrieved

RefreshInventory(Action)

Declaration

public virtual void RefreshInventory(Action refreshInventoryCallback)

Parameters

Type	Name	Description
Action	refreshInventoryCallback

RefreshInventoryAsync(Action)

Declaration

protected virtual Task RefreshInventoryAsync(Action onComplete)

Parameters

Type	Name	Description
Action	onComplete

Returns

Type	Description
Task

ResetUser()

Declaration

public virtual Task ResetUser()

Returns

Type	Description
Task

UpdateInventory(InventoryUpdateBuilder)

Declaration

public Task UpdateInventory(InventoryUpdateBuilder inventoryUpdateBuilder)

Parameters

Type	Name	Description
InventoryUpdateBuilder	inventoryUpdateBuilder

Returns

Type	Description
Task