Beamable.Common.Api.Inventory.AbsInventoryApi Class Reference

Inheritance diagram for Beamable.Common.Api.Inventory.AbsInventoryApi:

Collaboration diagram for Beamable.Common.Api.Inventory.AbsInventoryApi:

Public Member Functions
	AbsInventoryApi (IBeamableRequester requester, IUserContext userContext)
Promise< PreviewCurrencyGainResponse >	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. More...
Promise< GetMultipliersResponse >	GetMultipliers ()
	Provides the VIP Bonus multipliers that are applicable for this player according to their tier. More...
Promise< long >	GetCurrency (CurrencyRef currency)
Promise< Unit >	AddItem (ItemRef itemRef, Dictionary< string, string > properties=null, string transaction=null)
Promise< Unit >	AddItem (string contentId, Dictionary< string, string > properties=null, string transaction=null)
Promise< Unit >	DeleteItem (string contentId, long itemId, string transaction=null)
Promise< Unit >	UpdateItem (ItemRef itemRef, long itemId, Dictionary< string, string > properties, string transaction=null)
Promise< Unit >	UpdateItem (string contentId, long itemId, Dictionary< string, string > properties, string transaction=null)
Promise< Unit >	SetCurrency (CurrencyRef currency, long amount, string transaction=null)
Promise< Unit >	AddCurrency (string currencyId, long amount, string transaction=null)
Promise< Unit >	AddCurrency (CurrencyRef currency, long amount, string transaction=null)
Promise< Unit >	SetCurrencies (Dictionary< CurrencyRef, long > currencyToAmount, string transaction=null)
Promise< Unit >	AddCurrencies (Dictionary< string, long > currencyIdsToAmount, string transaction=null)
Promise< Unit >	AddCurrencies (Dictionary< CurrencyRef, long > currencyToAmount, string transaction=null)
Promise< Unit >	SetCurrency (string currencyId, long amount, string transaction=null)
Promise< Unit >	SetCurrencies (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< Unit >	Update (Action< InventoryUpdateBuilder > action, string transaction=null)
Promise< Unit >	Update (InventoryUpdateBuilder builder, string transaction=null)
Promise< List< InventoryObject< TContent > > >	GetItems< TContent > ()
Promise< List< InventoryObject< TContent > > >	GetItems< TContent > (params ItemRef< TContent >[] itemReferences)
abstract Promise< InventoryView >	GetCurrent (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:

• client/Packages/com.beamable/Common/Runtime/Api/Inventory/InventoryApi.cs