Method SetBalanceAsync

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.

Declaration

Task<PlayerBalance> SetBalanceAsync(string currencyId, long balance, SetBalanceOptions options = null)

Parameters

Type	Name	Description
string	currencyId	The currency ID to update
long	balance	The amount to set the balance to
SetBalanceOptions	options	(Optional) Used to set a write lock for optimistic concurrency

Returns

Type	Description
Task<PlayerBalance>	The updated player balance for the relevant currency.

Exceptions

Type	Condition
EconomyException	Thrown if request is unsuccessful
EconomyValidationException	Thrown if the service returned validation error.
EconomyRateLimitedException	Thrown if the service returned rate limited error.