Interface IEconomyPlayerBalancesApiClient

The PlayerBalances methods provide access to the current player's balances, and allow you to update them.

Namespace: Unity.Services.Economy

Assembly: solution.dll

Syntax

public interface IEconomyPlayerBalancesApiClient

Methods

Name	Description
DecrementBalanceAsync(string, int, DecrementBalanceOptions)	Decrements the balance of the specified currency for the currently logged in user. This method optionally takes a writeLock string. If provided, then an exception will be thrown unless the writeLock matches the writeLock received by a previous read, in order to provide optimistic concurrency. If not provided, the transaction will proceed regardless of any existing writeLock in the data. Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.
GetBalancesAsync(GetBalancesOptions)	Gets the current balances for the currently signed in player. The balances are available on the returned object using the Balances property. The results are paginated - the first set of results are initially returned, and more can be requested with the GetNextAsync method. The HasNext property indicates whether there are more results to be returned. Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.
IncrementBalanceAsync(string, int, IncrementBalanceOptions)	Increments the balance of the specified currency for the currently logged in user. This method optionally takes a writeLock string. If provided, then an exception will be thrown unless the writeLock matches the writeLock received by a previous read, in order to provide optomistic concurrency. If not provided, the transaction will proceed regardless of any existing writeLock in the data. Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.
SetBalanceAsync(string, long, SetBalanceOptions)	Sets the balance of the specified currency for the currently logged in user. Will throw an exception if the currency doesn't exist, or if the set amount will take the balance above/below the maximum/minimum allowed for that currency. This method optionally takes a writeLock string. If provided, then an exception will be thrown unless the writeLock matches the writeLock received by a previous read, in order to provide optimistic concurrency. If not provided, the transaction will proceed regardless of any existing writeLock in the data. Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.

Events

Name	Description
BalanceUpdated	Fires when the SDK updates a player's balance. The called action will be passed the currency ID that was updated. Note that this will NOT fire for balance changes from elsewhere not in this instance of the SDK, for example other server-side updates or updates from other devices.