Beamable SDK
Public Member Functions | List of all members
Beamable.Common.Api.Inventory.IInventoryApi Interface Reference
Inheritance diagram for Beamable.Common.Api.Inventory.IInventoryApi:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Common.Api.Inventory.IInventoryApi:
Collaboration graph
[legend]

Public Member Functions

Promise< GetMultipliersResponseGetMultipliers ()
 Provides the VIP Bonus multipliers that are applicable for this player according to their tier. More...
 
Promise< PreviewCurrencyGainResponsePreviewCurrencyGain (Dictionary< string, long > currencyIdsToAmount)
 Players may sometimes receive additional currency as a result of qualifying for a VIP Tier This API previews what that amount of currency would be ahead of an update. More...
 
Promise< UnitSetCurrency (string currencyId, long amount, string transaction=null)
 
Promise< UnitSetCurrency (CurrencyRef currency, long amount, string transaction=null)
 
Promise< UnitAddCurrency (string currencyId, long amount, string transaction=null)
 
Promise< UnitAddCurrency (CurrencyRef currency, long amount, string transaction=null)
 
Promise< UnitSetCurrencies (Dictionary< string, long > currencyIdsToAmount, string transaction=null)
 
Promise< UnitSetCurrencies (Dictionary< CurrencyRef, long > currencyToAmount, string transaction=null)
 
Promise< UnitAddCurrencies (Dictionary< string, long > currencyIdsToAmount, string transaction=null)
 
Promise< UnitAddCurrencies (Dictionary< CurrencyRef, long > currencyToAmount, string transaction=null)
 
Promise< Dictionary< string, long > > GetCurrencies (string[] currencyIds)
 
Promise< Dictionary< CurrencyRef, long > > GetCurrencies (CurrencyRef[] currencyRefs)
 
Promise< long > GetCurrency (string currencyId)
 
Promise< long > GetCurrency (CurrencyRef currency)
 
Promise< UnitAddItem (ItemRef itemRef, Dictionary< string, string > properties=null, string transaction=null)
 
Promise< UnitAddItem (string contentId, Dictionary< string, string > properties=null, string transaction=null)
 
Promise< UnitDeleteItem (string contentId, long itemId, string transaction=null)
 
Promise< UnitUpdateItem (ItemRef itemRef, long itemId, Dictionary< string, string > properties, string transaction=null)
 
Promise< UnitUpdateItem (string contentId, long itemId, Dictionary< string, string > properties, string transaction=null)
 
Promise< UnitUpdate (Action< InventoryUpdateBuilder > action, string transaction=null)
 
Promise< UnitUpdate (InventoryUpdateBuilder builder, string transaction=null)
 
Promise< List< InventoryObject< TContent > > > GetItems< TContent > ()
 
Promise< List< InventoryObject< TContent > > > GetItems< TContent > (params ItemRef< TContent >[] itemReferences)
 
- Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< InventoryView >
Promise< TData > GetCurrent (string scope="")
 

Member Function Documentation

◆ GetMultipliers()

Promise<GetMultipliersResponse> Beamable.Common.Api.Inventory.IInventoryApi.GetMultipliers ( )

Provides the VIP Bonus multipliers that are applicable for this player according to their tier.

Returns

Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.

◆ PreviewCurrencyGain()

Promise<PreviewCurrencyGainResponse> Beamable.Common.Api.Inventory.IInventoryApi.PreviewCurrencyGain ( Dictionary< string, long >  currencyIdsToAmount)

Players may sometimes receive additional currency as a result of qualifying for a VIP Tier This API previews what that amount of currency would be ahead of an update.

Parameters
currencyIdsToAmount
Returns

Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.


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