Documentation
Home
SDKs
Cloud Save Economy Friends Leaderboards Remote Config Vivox Lobby Matchmaker Multiplay Player Authentication Player Names
Economy SDK 2.1
Version 2.0 Version 2.1 Version 2.2 Version 2.3 Version 2.4 Version 2.5 Changelog

CurrenciesApi

Import

Import

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

Constructors

Constructor

Methods

Decrement Player Currency Balance

  • decrementPlayerCurrencyBalance(projectId: string, playerId: string, currencyId: string, configAssignmentHash?: string, currencyModifyBalanceRequest?: CurrencyModifyBalanceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CurrencyBalanceResponse>>

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

    summary

    Decrement Currency Balance

    throws

    {RequiredError}

    memberof

    CurrenciesApi

    Parameters

    • projectId: string

      ID of the project

    • playerId: string

      ID of the player

    • currencyId: string
    • Optional configAssignmentHash: string
    • Optional currencyModifyBalanceRequest: CurrencyModifyBalanceRequest
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<CurrencyBalanceResponse>>

Get Player Currencies

  • getPlayerCurrencies(projectId: string, playerId: string, configAssignmentHash?: string, after?: string, limit?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayerCurrencyBalanceResponse>>

  • Get a list of currency balances for a player. Results ordered by Currency ID ascending.

    summary

    Player Currency Balances

    throws

    {RequiredError}

    memberof

    CurrenciesApi

    Parameters

    • projectId: string

      ID of the project

    • playerId: string

      ID of the player

    • Optional configAssignmentHash: string
    • Optional after: string
    • Optional limit: number
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<PlayerCurrencyBalanceResponse>>

Increment Player Currency Balance

  • incrementPlayerCurrencyBalance(projectId: string, playerId: string, currencyId: string, configAssignmentHash?: string, currencyModifyBalanceRequest?: CurrencyModifyBalanceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CurrencyBalanceResponse>>

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

    summary

    Increment Currency Balance

    throws

    {RequiredError}

    memberof

    CurrenciesApi

    Parameters

    • projectId: string

      ID of the project

    • playerId: string

      ID of the player

    • currencyId: string
    • Optional configAssignmentHash: string
    • Optional currencyModifyBalanceRequest: CurrencyModifyBalanceRequest
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<CurrencyBalanceResponse>>

Set Player Currency Balance

  • setPlayerCurrencyBalance(projectId: string, playerId: string, currencyId: string, configAssignmentHash?: string, currencyBalanceRequest?: CurrencyBalanceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CurrencyBalanceResponse>>

  • Set a player's currency balance.

    summary

    Set Currency Balance

    throws

    {RequiredError}

    memberof

    CurrenciesApi

    Parameters

    • projectId: string

      ID of the project

    • playerId: string

      ID of the player

    • currencyId: string
    • Optional configAssignmentHash: string
    • Optional currencyBalanceRequest: CurrencyBalanceRequest
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<CurrencyBalanceResponse>>