Class GetInventoryResult
Provides paginated access to the list of retrieved player's inventory items.
Inherited Members
Namespace: Unity.Services.Economy.Model
Syntax
public class GetInventoryResult : PageableResult<PlayersInventoryItem, GetInventoryResult>
Constructors
GetInventoryResult(List<PlayersInventoryItem>, Boolean, List<String>, List<String>)
Declaration
public GetInventoryResult(List<PlayersInventoryItem> results, bool hasNext, List<string> inventoryItemIds, List<string> playersInventoryItemIds)
Parameters
| Type | Name | Description |
|---|---|---|
| List<PlayersInventoryItem> | results | |
| Boolean | hasNext | |
| List<String> | inventoryItemIds | |
| List<String> | playersInventoryItemIds |
Properties
PlayersInventoryItems
The currently fetched items.
Declaration
public List<PlayersInventoryItem> PlayersInventoryItems { get; }
Property Value
| Type | Description |
|---|---|
| List<PlayersInventoryItem> |
Methods
GetNextResultsAsync(Int32)
Retrieves the next page of the players inventory items.
Declaration
protected override Task<GetInventoryResult> GetNextResultsAsync(int itemsPerFetch)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | itemsPerFetch | The number of items to fetch. Can be between 1-100 inclusive and defaults to 20. |
Returns
| Type | Description |
|---|---|
| Task<GetInventoryResult> | A new GetInventoryResult |
Overrides
Unity.Services.Economy.Model.PageableResult<Unity.Services.Economy.Model.PlayersInventoryItem, Unity.Services.Economy.Model.GetInventoryResult>.GetNextResultsAsync(System.Int32)
Exceptions
| Type | Condition |
|---|---|
| EconomyException | Thrown if request is unsuccessful |