Beamable SDK
Public Member Functions | Static Public Attributes | Protected Member Functions | Properties | List of all members
Beamable.Common.Api.Inventory.AbsInventoryApi Class Referenceabstract
Inheritance diagram for Beamable.Common.Api.Inventory.AbsInventoryApi:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Common.Api.Inventory.AbsInventoryApi:
Collaboration graph
[legend]

Public Member Functions

 AbsInventoryApi (IBeamableRequester requester, IUserContext userContext)
 
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< GetMultipliersResponseGetMultipliers ()
 Provides the VIP Bonus multipliers that are applicable for this player according to their tier. More...
 
Promise< long > GetCurrency (CurrencyRef currency)
 
Promise< UnitAddItem (string contentId, Dictionary< string, string > properties, string transaction=null)
 
Promise< UnitDeleteItem (string contentId, long itemId, string transaction=null)
 
Promise< UnitUpdateItem (string contentId, long itemId, Dictionary< string, string > properties, 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< 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< UnitSetCurrency (string currencyId, long amount, string transaction=null)
 
Promise< UnitSetCurrencies (Dictionary< string, long > currencyIdsToAmount, string transaction=null)
 
Promise< Dictionary< string, long > > GetCurrencies (string[] currencyIds)
 
Promise< Dictionary< CurrencyRef, long > > GetCurrencies (CurrencyRef[] currencyRefs)
 
Promise< long > GetCurrency (string currencyId)
 
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)
 
abstract Promise< InventoryViewGetCurrent (string scope="")
 
- Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< InventoryView >
Promise< TData > GetCurrent (string scope="")
 

Static Public Attributes

const string SERVICE_OBJECT = "object/inventory"
 

Protected Member Functions

string CreateRefreshUrl (string scope)
 

Properties

IBeamableRequester Requester [get]
 
IUserContext UserContext [get]
 

Member Function Documentation

◆ GetMultipliers()

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

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

Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.

◆ PreviewCurrencyGain()

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

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

Implements Beamable.Common.Api.Inventory.IInventoryApi.


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