Beamable SDK
Public Member Functions | Static Public Attributes | Protected Member Functions | Properties | List of all members
Beamable.Common.Api.Inventory.AbsInventoryApi Class Referenceabstract

This type defines the Client main entry point for the Inventory feature. More...

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)
 Gets the currency. More...
 
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< UnitSetCurrency (CurrencyRef currency, long amount, string transaction=null)
 Sets the currency. More...
 
Promise< UnitSetCurrencyProperties (string currencyId, List< CurrencyProperty > properties, string transaction=null)
 
Promise< UnitSetCurrencyProperties (CurrencyRef currency, List< CurrencyProperty > properties, string transaction=null)
 
Promise< UnitAddCurrency (string currencyId, long amount, string transaction=null)
 Adds the currency More...
 
Promise< UnitAddCurrency (CurrencyRef currency, long amount, string transaction=null)
 Adds the currency More...
 
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)
 Sets the currency. More...
 
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)
 Gets the currency. More...
 
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="")
 Get the current data from the given scope. More...
 
- 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]
 

Detailed Description

This type defines the Client main entry point for the Inventory feature.

Related Links

img beamable-logo

Member Function Documentation

◆ AddCurrency() [1/2]

Promise<Unit> Beamable.Common.Api.Inventory.AbsInventoryApi.AddCurrency ( CurrencyRef  currency,
long  amount,
string  transaction = null 
)
inline

Adds the currency

Parameters
currency
amount
transaction
Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.

◆ AddCurrency() [2/2]

Promise<Unit> Beamable.Common.Api.Inventory.AbsInventoryApi.AddCurrency ( string  currencyId,
long  amount,
string  transaction = null 
)
inline

Adds the currency

Parameters
currencyId
amount
transaction
Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.

◆ GetCurrency() [1/2]

Promise<long> Beamable.Common.Api.Inventory.AbsInventoryApi.GetCurrency ( CurrencyRef  currency)
inline

Gets the currency.

Parameters
currency
Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.

◆ GetCurrency() [2/2]

Promise<long> Beamable.Common.Api.Inventory.AbsInventoryApi.GetCurrency ( string  currencyId)
inline

Gets the currency.

Parameters
currencyId
Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.

◆ GetCurrent()

abstract Promise<InventoryView> Beamable.Common.Api.Inventory.AbsInventoryApi.GetCurrent ( string  scope = "")
pure virtual

Get the current data from the given scope.

Parameters
scope
Returns

Implemented in Beamable.Api.Inventory.InventoryService, and Beamable.Server.Api.Inventory.MicroserviceInventoryApi.

◆ 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.

◆ SetCurrency() [1/2]

Promise<Unit> Beamable.Common.Api.Inventory.AbsInventoryApi.SetCurrency ( CurrencyRef  currency,
long  amount,
string  transaction = null 
)
inline

Sets the currency.

Parameters
currency
amount
transaction
Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.

◆ SetCurrency() [2/2]

Promise<Unit> Beamable.Common.Api.Inventory.AbsInventoryApi.SetCurrency ( string  currencyId,
long  amount,
string  transaction = null 
)
inline

Sets the currency.

Parameters
currencyId
amount
transaction
Returns

Implements Beamable.Common.Api.Inventory.IInventoryApi.


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