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
Type | Name | Description |
---|---|---|
String | inventoryItemId | The item ID to add |
AddInventoryItemOptions | options | (Optional) Use to set the PlayersInventoryItem ID for the created instance and instance data. |
Returns
Type | Description |
---|---|
Task<PlayersInventoryItem> | The created player inventory item. |
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. |
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
Type | Name | Description |
---|---|---|
String | playersInventoryItemId | PlayersInventoryItem ID for the created inventory item |
DeletePlayersInventoryItemOptions | options | (Optional) Use to set a write lock for optimistic concurrency |
Returns
Type | Description |
---|---|
Task |
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. |
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
GetNextAsync
HasNext
Declaration
Task<GetInventoryResult> GetInventoryAsync(GetInventoryOptions options = null)
Parameters
Type | Name | Description |
---|---|---|
GetInventoryOptions | options | (Optional) Use to set request options. See GetInventoryOptions for more details. |
Returns
Type | Description |
---|---|
Task<GetInventoryResult> | A GetInventoryResult object, with properties as specified above. |
Exceptions
Type | Condition |
---|---|
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
Type | Name | Description |
---|---|---|
String | playersInventoryItemId | PlayersInventoryItem ID for the created inventory item |
Object | instanceData | Instance data |
UpdatePlayersInventoryItemOptions | options | (Optional) Use to set a write lock for optimistic concurrency |
Returns
Type | Description |
---|---|
Task<PlayersInventoryItem> |
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. |
Events
PlayersInventoryItemUpdated
Declaration
event Action<string> PlayersInventoryItemUpdated
Event Type
Type | Description |
---|---|
Action<String> |