Interface IEconomyPlayerInventoryApiClient

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

Namespace: Unity.Services.Economy

Assembly: Unity.Services.Economy.dll

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	Object representing the continuation of the 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 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

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>	The updated 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.

Events

PlayersInventoryItemUpdated

Fires when the SDK updates a player's inventory item (e.g. by editing the custom data). The called function will be passed the player inventory item ID that was updated. (Note: this is the ID of the individual inventory item owned by the player, not the item configuration). 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.

Declaration

event Action<string> PlayersInventoryItemUpdated

Event Type

Type	Description
Action<string>