Method GetInventoryAsync
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. |