Loading...
Searching...
No Matches
AccelByte.Api.Inventory Class Reference
Inheritance diagram for AccelByte.Api.Inventory:

Public Member Functions

void BulkDeleteInventoryItems (string inventoryId, DeleteUserInventoryItemRequest[] deletedItemsRequest, ResultCallback< DeleteUserInventoryItemResponse[]> callback)
void BulkDeleteInventoryItems (string inventoryId, BulkDeleteUserInventoryItemsPayload[] payload, ResultCallback< DeleteUserInventoryItemResponse[]> callback)
 Deletes user's inventory items in bulk.
void BulkUpdateInventoryItems (string inventoryId, UpdateUserInventoryItemRequest[] updatedItemsRequest, ResultCallback< UpdateUserInventoryItemResponse[]> callback)
void BulkUpdateInventoryItems (string inventoryId, BulkUpdateInventoryItemsPayload[] payload, ResultCallback< UpdateUserInventoryItemResponse[]> callback)
 Updates user's inventory items in bulk.
void ConsumeUserInventoryItem (string inventoryId, ConsumeUserItemsRequest consumedItemsRequest, ResultCallback< UserItem > callback)
void ConsumeUserInventoryItem (string inventoryId, uint qty, string sourceItemId, ConsumeUserInventoryItemOptionalParameters optionalParams, ResultCallback< UserItem > callback)
 Consume item from user's inventory.
void GetInventoryConfigurations (ResultCallback< InventoryConfigurationsPagingResponse > callback, InventoryConfigurationSortBy sortBy=InventoryConfigurationSortBy.CreatedAt, int limit=25, int offset=0, string inventoryConfigurationCode="")
 Retrieves all inventory configurations on the namespace.
void GetInventoryTags (ResultCallback< InventoryTagsPagingResponse > callback, ItemTypeSortBy sortBy=ItemTypeSortBy.CreatedAt, int limit=25, int offset=0)
 Retrieves all available inventory tags on the current namespace.
void GetItemTypes (ResultCallback< ItemTypesPagingResponse > callback, ItemTypeSortBy sortBy=ItemTypeSortBy.CreatedAt, int limit=25, int offset=0)
 Retrieves available item types on the current namespace.
void GetUserInventories (ResultCallback< UserInventoriesPagingResponse > callback, UserInventorySortBy sortBy=UserInventorySortBy.CreatedAt, int limit=25, int offset=0, string inventoryConfigurationCode="")
 Retrieves all of the current user's available inventories.
void GetUserInventoryAllItems (string inventoryId, ResultCallback< UserItemsPagingResponse > callback)
 List all user's Item in an inventory.
void GetUserInventoryAllItems (string inventoryId, GetUserInventoryAllItemsOptionalParameters optionalParameters, ResultCallback< UserItemsPagingResponse > callback)
 List all user's Item in an inventory.
void GetUserInventoryAllItems (string inventoryId, ResultCallback< UserItemsPagingResponse > callback, UserItemSortBy sortBy=UserItemSortBy.CreatedAt, int limit=25, int offset=0, string sourceItemId="", TagQueryBuilder tagBuilder=null, int? quantity=null)
void GetUserInventoryItem (string inventoryId, string slotId, string sourceItemId, ResultCallback< UserItem > callback)
 Get data of specific item in the user's inventory.
void MoveItemsBetweenInventories (string targetInventoryId, MoveUserItemsBetweenInventoriesRequest moveItemsRequest, ResultCallback< MoveUserItemsBetweenInventoriesResponse > callback)
void MoveItemsBetweenInventories (string targetInventoryId, string sourceInventoryId, MoveUserItemsBetweenInventoriesPayload[] payload, ResultCallback< MoveUserItemsBetweenInventoriesResponse > callback)
 Moves user's item from one inventory to another.

Additional Inherited Members

Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator IdValidator [get]

Member Function Documentation

◆ BulkDeleteInventoryItems()

void AccelByte.Api.Inventory.BulkDeleteInventoryItems ( string inventoryId,
BulkDeleteUserInventoryItemsPayload[] payload,
ResultCallback< DeleteUserInventoryItemResponse[]> callback )
inline

Deletes user's inventory items in bulk.

Parameters
inventoryIdId of inventory to delete items for
payloadData of items to delete
callbackReturns a Result via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.

◆ BulkUpdateInventoryItems()

void AccelByte.Api.Inventory.BulkUpdateInventoryItems ( string inventoryId,
BulkUpdateInventoryItemsPayload[] payload,
ResultCallback< UpdateUserInventoryItemResponse[]> callback )
inline

Updates user's inventory items in bulk.

Parameters
inventoryIdId of inventory to update items for
payloadData of items to update
callbackReturns a Result via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.

◆ ConsumeUserInventoryItem()

void AccelByte.Api.Inventory.ConsumeUserInventoryItem ( string inventoryId,
uint qty,
string sourceItemId,
ConsumeUserInventoryItemOptionalParameters optionalParams,
ResultCallback< UserItem > callback )
inline

Consume item from user's inventory.

Parameters
inventoryIdId of inventory to consume items from
qtyAmount of items to consume
sourceItemIdId of item to consume
optionalParamsOptional parameters. Can be null.
callbackReturns a Result via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetInventoryConfigurations()

void AccelByte.Api.Inventory.GetInventoryConfigurations ( ResultCallback< InventoryConfigurationsPagingResponse > callback,
InventoryConfigurationSortBy sortBy = InventoryConfigurationSortBy.CreatedAt,
int limit = 25,
int offset = 0,
string inventoryConfigurationCode = "" )
inline

Retrieves all inventory configurations on the namespace.

Parameters
callbackReturns a Result via callback when completed
sortByOptional parameter to sort result items by
limitOptional parameter to limit amount of items returned in a page
offsetOptional parameter to traverse pagination by amount of items
inventoryConfigurationCodeOptional parameter to filter result items by inventory configuration code

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetInventoryTags()

void AccelByte.Api.Inventory.GetInventoryTags ( ResultCallback< InventoryTagsPagingResponse > callback,
ItemTypeSortBy sortBy = ItemTypeSortBy.CreatedAt,
int limit = 25,
int offset = 0 )
inline

Retrieves all available inventory tags on the current namespace.

Parameters
callbackReturns a result via callback when completed
sortByOptional parameter to sort result items by
limitOptional parameter to limit amount of items returned in a page
offsetOptional parameter to traverse pagination by amount of items

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetItemTypes()

void AccelByte.Api.Inventory.GetItemTypes ( ResultCallback< ItemTypesPagingResponse > callback,
ItemTypeSortBy sortBy = ItemTypeSortBy.CreatedAt,
int limit = 25,
int offset = 0 )
inline

Retrieves available item types on the current namespace.

Parameters
callbackReturns a result via callback when completed
sortByOptional parameter to sort result items by
limitOptional parameter to limit amount of items returned in a page
offsetOptional parameter to traverse pagination by amount of items

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetUserInventories()

void AccelByte.Api.Inventory.GetUserInventories ( ResultCallback< UserInventoriesPagingResponse > callback,
UserInventorySortBy sortBy = UserInventorySortBy.CreatedAt,
int limit = 25,
int offset = 0,
string inventoryConfigurationCode = "" )
inline

Retrieves all of the current user's available inventories.

Parameters
callbackReturns a result via callback when completed
sortByOptional parameter to sort result items by
limitOptional parameter to limit amount of items returned in a page
offsetOptional parameter to traverse pagination by amount of items
inventoryConfigurationCodeOptional parameter to filter result items by inventory configuration code

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetUserInventoryAllItems() [1/2]

void AccelByte.Api.Inventory.GetUserInventoryAllItems ( string inventoryId,
GetUserInventoryAllItemsOptionalParameters optionalParameters,
ResultCallback< UserItemsPagingResponse > callback )
inline

List all user's Item in an inventory.

Parameters
inventoryIdSelected inventory Id
optionalParametersOptional parameter to get specific result
callbackReturns a Result that contains UserItemsPagingResponse via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetUserInventoryAllItems() [2/2]

void AccelByte.Api.Inventory.GetUserInventoryAllItems ( string inventoryId,
ResultCallback< UserItemsPagingResponse > callback )
inline

List all user's Item in an inventory.

Parameters
inventoryIdselected inventory Id
callbackReturns a Result that contains UserItemsPagingResponse via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.

◆ GetUserInventoryItem()

void AccelByte.Api.Inventory.GetUserInventoryItem ( string inventoryId,
string slotId,
string sourceItemId,
ResultCallback< UserItem > callback )
inline

Get data of specific item in the user's inventory.

Parameters
inventoryIdId of inventory the item is in
slotIdId of slot the item occupies
sourceItemIdId of item to get data for
callbackReturns a Result via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.

◆ MoveItemsBetweenInventories()

void AccelByte.Api.Inventory.MoveItemsBetweenInventories ( string targetInventoryId,
string sourceInventoryId,
MoveUserItemsBetweenInventoriesPayload[] payload,
ResultCallback< MoveUserItemsBetweenInventoriesResponse > callback )
inline

Moves user's item from one inventory to another.

Parameters
targetInventoryIdId of inventory to move items to
sourceInventoryIdId of inventory to move items from
payloadData of items to be moved
callbackReturns a Result via callback when completed

Implements AccelByte.Api.Interface.IClientInventory.