Cloud Code Services SDKs

CurrenciesApi

Import

Import

const { CurrenciesApi } = require("@unity-services/economy-2.5");

Constructors

Constructor

new CurrenciesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): CurrenciesApi

Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns CurrenciesApi

Methods

Decrement Player Currency Balance

decrementPlayerCurrencyBalance(requestParameters: CurrenciesApiDecrementPlayerCurrencyBalanceRequest, options?: RawAxiosRequestConfig<any>): Promise<AxiosResponse<CurrencyBalanceResponse, any>>

Decrements a player's currency balance by a given value.

summary

Decrement currency balance

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- requestParameters: CurrenciesApiDecrementPlayerCurrencyBalanceRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<CurrencyBalanceResponse, any>>

Get Player Currencies

getPlayerCurrencies(requestParameters: CurrenciesApiGetPlayerCurrenciesRequest, options?: RawAxiosRequestConfig<any>): Promise<AxiosResponse<PlayerCurrencyBalanceResponse, any>>

Get a list of currency balances for a player. Results ordered in ascending currency ID.

summary

Player currency balances

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- requestParameters: CurrenciesApiGetPlayerCurrenciesRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<PlayerCurrencyBalanceResponse, any>>

Increment Player Currency Balance

incrementPlayerCurrencyBalance(requestParameters: CurrenciesApiIncrementPlayerCurrencyBalanceRequest, options?: RawAxiosRequestConfig<any>): Promise<AxiosResponse<CurrencyBalanceResponse, any>>

Increment a player's currency balance by a given value.

summary

Increment currency balance

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- requestParameters: CurrenciesApiIncrementPlayerCurrencyBalanceRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<CurrencyBalanceResponse, any>>

Set Player Currency Balance

setPlayerCurrencyBalance(requestParameters: CurrenciesApiSetPlayerCurrencyBalanceRequest, options?: RawAxiosRequestConfig<any>): Promise<AxiosResponse<CurrencyBalanceResponse, any>>

Set a player's currency balance.

summary

Set currency balance

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- requestParameters: CurrenciesApiSetPlayerCurrencyBalanceRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<CurrencyBalanceResponse, any>>