v3.1.2
2020.3+

Interface IEconomyPlayerInventoryApiClient

The PlayerInventory methods provide access to the current player's inventory items, and allow you to update them.

Namespace: Unity.Services.Economy
Syntax
public interface IEconomyPlayerInventoryApiClient

Methods

AddInventoryItemAsync(String, AddInventoryItemOptions)

Adds an inventory item to the player's inventory.

Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.

Declaration
Task<PlayersInventoryItem> AddInventoryItemAsync(string inventoryItemId, AddInventoryItemOptions options = null)
Parameters
TypeNameDescription
StringinventoryItemId

The item ID to add

AddInventoryItemOptionsoptions

(Optional) Use to set the PlayersInventoryItem ID for the created instance and instance data.

Returns
TypeDescription
Task<PlayersInventoryItem>

The created player inventory item.

Exceptions
TypeCondition
EconomyException

Thrown if request is unsuccessful

EconomyValidationException

Thrown if the service returned validation error.

EconomyRateLimitedException

Thrown if the service returned rate limited error.

DeletePlayersInventoryItemAsync(String, DeletePlayersInventoryItemOptions)

Deletes an item in the player's inventory.

Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.

Declaration
Task DeletePlayersInventoryItemAsync(string playersInventoryItemId, DeletePlayersInventoryItemOptions options = null)
Parameters
TypeNameDescription
StringplayersInventoryItemId

PlayersInventoryItem ID for the created inventory item

DeletePlayersInventoryItemOptionsoptions

(Optional) Use to set a write lock for optimistic concurrency

Returns
TypeDescription
Task
Exceptions
TypeCondition
EconomyException

Thrown if request is unsuccessful

EconomyValidationException

Thrown if the service returned validation error.

EconomyRateLimitedException

Thrown if the service returned rate limited error.

GetInventoryAsync(GetInventoryOptions)

Gets the inventory items in the inventory of the player that is currently signed in. The players items are available on the returned object using the

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

Declaration
Task<GetInventoryResult> GetInventoryAsync(GetInventoryOptions options = null)
Parameters
TypeNameDescription
GetInventoryOptionsoptions

(Optional) Use to set request options. See GetInventoryOptions for more details.

Returns
TypeDescription
Task<GetInventoryResult>

A GetInventoryResult object, with properties as specified above.

Exceptions
TypeCondition
EconomyException

Thrown if request is unsuccessful

EconomyRateLimitedException

Thrown if the service returned rate limited error.

UpdatePlayersInventoryItemAsync(String, Object, UpdatePlayersInventoryItemOptions)

Updates the instance data of an item in the player's inventory.

Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.

Declaration
Task<PlayersInventoryItem> UpdatePlayersInventoryItemAsync(string playersInventoryItemId, object instanceData, UpdatePlayersInventoryItemOptions options = null)
Parameters
TypeNameDescription
StringplayersInventoryItemId

PlayersInventoryItem ID for the created inventory item

ObjectinstanceData

Instance data

UpdatePlayersInventoryItemOptionsoptions

(Optional) Use to set a write lock for optimistic concurrency

Returns
TypeDescription
Task<PlayersInventoryItem>
Exceptions
TypeCondition
EconomyException

Thrown if request is unsuccessful

EconomyValidationException

Thrown if the service returned validation error.

EconomyRateLimitedException

Thrown if the service returned rate limited error.

Events

PlayersInventoryItemUpdated

Declaration
event Action<string> PlayersInventoryItemUpdated
Event Type
TypeDescription
Action<String>