This interface defines the API for InventoryService. More...
Inheritance diagram for Beamable.Common.Api.Inventory.IInventoryApi:
Collaboration diagram for Beamable.Common.Api.Inventory.IInventoryApi:
Public Member Functions | |
| Promise< GetMultipliersResponse > | GetMultipliers () |
| Provides the VIP Bonus multipliers that are applicable for this player according to their tier. More... | |
| 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< Unit > | SetCurrency (string currencyId, long amount, string transaction=null) |
| Sets the currency. More... | |
| Promise< Unit > | SetCurrency (CurrencyRef currency, long amount, string transaction=null) |
| Sets the currency. More... | |
| Promise< Unit > | AddCurrency (string currencyId, long amount, string transaction=null) |
| Adds the currency More... | |
| Promise< Unit > | AddCurrency (CurrencyRef currency, long amount, string transaction=null) |
| Adds the currency More... | |
| Promise< Unit > | SetCurrencies (Dictionary< string, long > currencyIdsToAmount, 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< Dictionary< string, long > > | GetCurrencies (string[] currencyIds) |
| Promise< Dictionary< CurrencyRef, long > > | GetCurrencies (CurrencyRef[] currencyRefs) |
| Promise< long > | GetCurrency (string currencyId) |
| Gets the currency. More... | |
| Promise< long > | GetCurrency (CurrencyRef currency) |
| Gets the currency. More... | |
| 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 > | 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) |
 Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< InventoryView > | |
| Promise< TData > | GetCurrent (string scope="") |
Detailed Description
This interface defines the API for InventoryService.
Related Links
- See the Inventory feature documentation
- See InventoryService script reference
Member Function Documentation
◆ AddCurrency() [1/2]
| Promise<Unit> Beamable.Common.Api.Inventory.IInventoryApi.AddCurrency | ( | CurrencyRef | currency, |
| long | amount, | ||
| string | transaction = null |
||
| ) |
Adds the currency
- Parameters
-
currency amount transaction
- Returns
Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.
◆ AddCurrency() [2/2]
| Promise<Unit> Beamable.Common.Api.Inventory.IInventoryApi.AddCurrency | ( | string | currencyId, |
| long | amount, | ||
| string | transaction = null |
||
| ) |
Adds the currency
- Parameters
-
currencyId amount transaction
- Returns
Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.
◆ GetCurrency() [1/2]
| Promise<long> Beamable.Common.Api.Inventory.IInventoryApi.GetCurrency | ( | CurrencyRef | currency | ) |
Gets the currency.
- Parameters
-
currency
- Returns
Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.
◆ GetCurrency() [2/2]
| Promise<long> Beamable.Common.Api.Inventory.IInventoryApi.GetCurrency | ( | string | currencyId | ) |
Gets the currency.
- Parameters
-
currencyId
- Returns
Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.
◆ 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.
◆ SetCurrency() [1/2]
| Promise<Unit> Beamable.Common.Api.Inventory.IInventoryApi.SetCurrency | ( | CurrencyRef | currency, |
| long | amount, | ||
| string | transaction = null |
||
| ) |
Sets the currency.
- Parameters
-
currency amount transaction
- Returns
Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.
◆ SetCurrency() [2/2]
| Promise<Unit> Beamable.Common.Api.Inventory.IInventoryApi.SetCurrency | ( | string | currencyId, |
| long | amount, | ||
| string | transaction = null |
||
| ) |
Sets the currency.
- Parameters
-
currencyId amount transaction
- Returns
Implemented in Beamable.Common.Api.Inventory.AbsInventoryApi.
The documentation for this interface was generated from the following file:
- client/Packages/com.beamable/Common/Runtime/Api/Inventory/IInventoryApi.cs
