Loading...
Searching...
No Matches
AccelByte.Server.ServerInventory Class Reference

Provide an API to access Inventory service. More...

Inheritance diagram for AccelByte.Server.ServerInventory:

Public Member Functions

void BulkDeleteUserInventoryItems (string inventoryId, string userId, DeleteUserInventoryItemRequest[] request, ResultCallback< DeleteUserInventoryItemResponse[]> callback)
void BulkDeleteUserInventoryItems (string inventoryId, string userId, BulkDeleteUserInventoryItemsPayload[] payload, ResultCallback< DeleteUserInventoryItemResponse[]> callback)
 Remove items from player's inventory.
void BulkUpdateUserInventoryItems (string inventoryId, string userId, ServerUpdateUserInventoryItemRequest[] request, ResultCallback< UpdateUserInventoryItemResponse[]> callback)
void BulkUpdateUserInventoryItems (string inventoryId, string userId, ServerUpdateUserInventoryItemPayload[] payload, ResultCallback< UpdateUserInventoryItemResponse[]> callback)
 Update item attributes and tags for a specidic user.
void ConsumeUserInventoryItem (string inventoryId, string userId, ConsumeUserItemsRequest request, ResultCallback< UserItem > callback)
void ConsumeUserInventoryItem (string inventoryId, string userId, uint qty, string sourceItemId, ConsumeUserInventoryItemOptionalParameters optionalParameters, ResultCallback< UserItem > callback)
 Make a user consume item.
void CreateIntegrationConfiguration (ServerCreateIntegrationConfigurationRequest request, ResultCallback< ServerIntegrationConfiguration > callback)
 Creates a new integration configuration on the current namespace.
void CreateInventoryConfiguration (ServerCreateInventoryConfigurationRequest request, ResultCallback< InventoryConfiguration > callback)
void CreateInventoryConfiguration (string code, uint initialMaxSlots, uint maxInstancesPerUser, uint maxUpgradeSlots, CreateInventoryConfigurationOptionalParameters optionalParameters, ResultCallback< InventoryConfiguration > callback)
 Creates a new inventory configuration for the current namespace.
void CreateInventoryTag (ServerCreateInventoryTagRequest request, ResultCallback< InventoryTag > callback)
void CreateInventoryTag (string name, string inventoryOwner, ResultCallback< InventoryTag > callback)
 Create an inventory tag on the current namespace.
void CreateItemTypes (ServerCreateItemTypeRequest request, ResultCallback< InventoryItemType > callback)
void CreateItemTypes (string name, ResultCallback< InventoryItemType > callback)
 Create a new item type on the current namespace.
void CreateUserInventory (ServerCreateInventoryRequest request, ResultCallback< UserInventory > callback)
 Grant inventory to the player.
void DeleteInventoryConfiguration (string inventoryConfigurationId, ResultCallback callback)
 Deletes inventory configuration data via its configuration Id.
void DeleteInventoryTag (string tagName, ResultCallback callback)
 Delete an inventory tag on the current namespace via its name.
void DeleteItemTypes (string itemTypeName, ResultCallback callback)
 Delete an item type on the current namespace via its name.
void DeleteUserInventory (string inventoryId, ServerDeleteInventoryRequest request, ResultCallback callback)
 Delete user inventory based on inventory id.
void GetAllInventoryConfigurations (ResultCallback< InventoryConfigurationsPagingResponse > callback, InventoryConfigurationSortBy sortBy=InventoryConfigurationSortBy.CreatedAt, int limit=25, int offset=0, string inventoryConfigurationCode="")
 Retrieves all inventory configurations on the namespace.
void GetIntegrationConfigurations (ResultCallback< ServerIntegrationConfigurationsPagingResponse > callback, ServerIntegrationConfigurationSortBy sortBy=ServerIntegrationConfigurationSortBy.CreatedAt, int limit=25, int offset=0)
 Retrieves all available integration configurations on the current namespace.
void GetInventoryConfiguration (string inventoryConfigurationId, ResultCallback< InventoryConfiguration > callback)
 Retrieves inventory configuration data via its configuration Id.
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="", string userId="")
 Retrieve list of user inventories.
void GetUserInventory (string inventoryId, ResultCallback< UserInventory > callback)
void GetUserInventoryAllItems (string inventoryId, ResultCallback< UserItemsPagingResponse > callback)
 Retrieve a list of user inventories.
void GetUserInventoryAllItems (string inventoryId, GetUserInventoryAllItemsOptionalParameters optionalParam, ResultCallback< UserItemsPagingResponse > callback)
 Retrieve a list of user inventories.
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)
 Listing all items in an inventory.
void RunChainingOperation (ServerInventoryChainingOperationRequest request, ResultCallback< InventoryChainingOperationResponse > callback)
 Run a series of inventory operations as defined on request.
void SaveUserInventoryItem (string userId, string inventoryConfigurationCode, string source, string sourceItemId, string type, uint quantity, ResultCallback< UserItem > callback)
 Add item to player inventory using inventoryConfigurationCode.
void SaveUserInventoryItem (string userId, string inventoryConfigurationCode, string source, string sourceItemId, string type, uint quantity, SaveUserInventoryItemOptionalParameters optionalParameters, ResultCallback< UserItem > callback)
 Add item to player inventory using inventoryConfigurationCode.
void SaveUserInventoryItemToInventory (string userId, string inventoryId, ServerSaveUserInventoryItemRequest request, ResultCallback< UserItem > callback)
void SaveUserInventoryItemToInventory (string inventoryId, string userId, string source, string sourceItemId, string type, uint quantity, SaveUserInventoryItemToInventoryOptionalParameters optionalParameters, ResultCallback< UserItem > callback)
 Add item to player inventory using inventoryId.
void SyncUserEntitlements (string userId, ResultCallback callback)
 Synchronizes user entitlement data to Inventory service.
void UpdateIntegrationConfiguration (string integrationConfigurationId, ServerUpdateIntegrationConfigurationRequest request, ResultCallback< ServerIntegrationConfiguration > callback)
 Updates an integration configuration via its id.
void UpdateIntegrationConfigurationStatus (string integrationConfigurationId, ServerUpdateIntegrationConfigurationStatusRequest request, ResultCallback< ServerIntegrationConfiguration > callback)
 Updates an integration configuration's status via its id.
void UpdateInventoryConfiguration (string inventoryConfigurationId, ServerUpdateInventoryConfigurationRequest request, ResultCallback< InventoryConfiguration > callback)
 Updates inventory configuration data via its configuration Id.
void UpdateUserInventory (string inventoryId, ServerUpdateInventoryRequest request, ResultCallback< UserInventory > callback)
 Update user inventory slot limit.
void ValidateUserInventoryCapacity (string userId, ServerValidateUserInventoryCapacityRequest request, ResultCallback callback)
 Validates the capacity of a user's inventory.

Additional Inherited Members

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

Detailed Description

Provide an API to access Inventory service.

Member Function Documentation

◆ BulkDeleteUserInventoryItems()

void AccelByte.Server.ServerInventory.BulkDeleteUserInventoryItems ( string inventoryId,
string userId,
BulkDeleteUserInventoryItemsPayload[] payload,
ResultCallback< DeleteUserInventoryItemResponse[]> callback )
inline

Remove items from player's inventory.

Parameters
inventoryIdInventoryId to be process
userIduser to be process
payloadrequest body contains the item detail
callbackReturns a Result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ BulkUpdateUserInventoryItems()

void AccelByte.Server.ServerInventory.BulkUpdateUserInventoryItems ( string inventoryId,
string userId,
ServerUpdateUserInventoryItemPayload[] payload,
ResultCallback< UpdateUserInventoryItemResponse[]> callback )
inline

Update item attributes and tags for a specidic user.

Parameters
inventoryIdInventoryId to be process
userIdUser id to be processed
payloadDetailed data to be processed
callbackReturns a Result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ ConsumeUserInventoryItem()

void AccelByte.Server.ServerInventory.ConsumeUserInventoryItem ( string inventoryId,
string userId,
uint qty,
string sourceItemId,
ConsumeUserInventoryItemOptionalParameters optionalParameters,
ResultCallback< UserItem > callback )
inline

Make a user consume item.

Parameters
inventoryIdInventoryId to be process
userIdUser id to be processed
qtyAmount of item to consume
sourceItemIdItem id to consume
optionalParametersOptional parameters. Can be null.
callbackReturns a Result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ CreateIntegrationConfiguration()

void AccelByte.Server.ServerInventory.CreateIntegrationConfiguration ( ServerCreateIntegrationConfigurationRequest request,
ResultCallback< ServerIntegrationConfiguration > callback )
inline

Creates a new integration configuration on the current namespace.

Parameters
requestData of integration configuration to create
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ CreateInventoryConfiguration()

void AccelByte.Server.ServerInventory.CreateInventoryConfiguration ( string code,
uint initialMaxSlots,
uint maxInstancesPerUser,
uint maxUpgradeSlots,
CreateInventoryConfigurationOptionalParameters optionalParameters,
ResultCallback< InventoryConfiguration > callback )
inline

Creates a new inventory configuration for the current namespace.

Parameters
codeConfiguration code for the new inventory configuration
initialMaxSlotsStarting slots when an inventory is created using the configuration
maxInstancesPerUserMaximum instances of the inventory type per user
maxUpgradeSlotsMaximum slots of the inventory when fully upgraded
optionalParametersOptional parameters. Can be null.
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ CreateInventoryTag()

void AccelByte.Server.ServerInventory.CreateInventoryTag ( string name,
string inventoryOwner,
ResultCallback< InventoryTag > callback )
inline

Create an inventory tag on the current namespace.

Parameters
nameName of the inventory tag to create
inventoryOwnerOwner of inventory tag to create
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ CreateItemTypes()

void AccelByte.Server.ServerInventory.CreateItemTypes ( string name,
ResultCallback< InventoryItemType > callback )
inline

Create a new item type on the current namespace.

Parameters
nameName of item type to create.
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ CreateUserInventory()

void AccelByte.Server.ServerInventory.CreateUserInventory ( ServerCreateInventoryRequest request,
ResultCallback< UserInventory > callback )
inline

Grant inventory to the player.

Parameters
requestDetailed data to be processed
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ DeleteInventoryConfiguration()

void AccelByte.Server.ServerInventory.DeleteInventoryConfiguration ( string inventoryConfigurationId,
ResultCallback callback )
inline

Deletes inventory configuration data via its configuration Id.

Parameters
inventoryConfigurationIdId of inventory configuration to delete
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ DeleteInventoryTag()

void AccelByte.Server.ServerInventory.DeleteInventoryTag ( string tagName,
ResultCallback callback )
inline

Delete an inventory tag on the current namespace via its name.

Parameters
tagNameInventory tag name to delete
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ DeleteItemTypes()

void AccelByte.Server.ServerInventory.DeleteItemTypes ( string itemTypeName,
ResultCallback callback )
inline

Delete an item type on the current namespace via its name.

Parameters
itemTypeNameName of item type to delete.
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ DeleteUserInventory()

void AccelByte.Server.ServerInventory.DeleteUserInventory ( string inventoryId,
ServerDeleteInventoryRequest request,
ResultCallback callback )
inline

Delete user inventory based on inventory id.

Parameters
inventoryIdInventory Id to be processed
requestDetailed data to be processed
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ GetAllInventoryConfigurations()

void AccelByte.Server.ServerInventory.GetAllInventoryConfigurations ( 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.Server.Interface.IServerInventory.

◆ GetIntegrationConfigurations()

void AccelByte.Server.ServerInventory.GetIntegrationConfigurations ( ResultCallback< ServerIntegrationConfigurationsPagingResponse > callback,
ServerIntegrationConfigurationSortBy sortBy = ServerIntegrationConfigurationSortBy.CreatedAt,
int limit = 25,
int offset = 0 )
inline

Retrieves all available integration configurations on the current namespace.

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

Implements AccelByte.Server.Interface.IServerInventory.

◆ GetInventoryConfiguration()

void AccelByte.Server.ServerInventory.GetInventoryConfiguration ( string inventoryConfigurationId,
ResultCallback< InventoryConfiguration > callback )
inline

Retrieves inventory configuration data via its configuration Id.

Parameters
inventoryConfigurationIdId of inventory configuration to fetch data for
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ GetInventoryTags()

void AccelByte.Server.ServerInventory.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.Server.Interface.IServerInventory.

◆ GetItemTypes()

void AccelByte.Server.ServerInventory.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.Server.Interface.IServerInventory.

◆ GetUserInventories()

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

Retrieve list of user inventories.

Parameters
callback
sortByOptional parameter to set inventory list order
limitOptional parameter to define limit for the result length
offsetOptional parameter to define offset for the result
inventoryConfigurationCodeOptional parameter to query based on inventory configuration code
userIdOptional parameter to query based on a specific userId

Implements AccelByte.Server.Interface.IServerInventory.

◆ GetUserInventory()

void AccelByte.Server.ServerInventory.GetUserInventory ( string inventoryId,
ResultCallback< UserInventory > callback )
inline

◆ GetUserInventoryAllItems() [1/2]

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

Retrieve a list of user inventories.

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

Implements AccelByte.Server.Interface.IServerInventory.

◆ GetUserInventoryAllItems() [2/2]

void AccelByte.Server.ServerInventory.GetUserInventoryAllItems ( string inventoryId,
ResultCallback< UserItemsPagingResponse > callback )
inline

Retrieve a list of user inventories.

Parameters
inventoryIdSelected inventory Id
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ GetUserInventoryItem()

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

Listing all items in an inventory.

Parameters
inventoryIdSelected inventory Id
slotIdslot id to be fetch
sourceItemIditem id to fetch
callbackReturns a Result that contains UserItem via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ RunChainingOperation()

void AccelByte.Server.ServerInventory.RunChainingOperation ( ServerInventoryChainingOperationRequest request,
ResultCallback< InventoryChainingOperationResponse > callback )
inline

Run a series of inventory operations as defined on request.

Parameters
requestOperations to run, sequentially by index
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ SaveUserInventoryItem() [1/2]

void AccelByte.Server.ServerInventory.SaveUserInventoryItem ( string userId,
string inventoryConfigurationCode,
string source,
string sourceItemId,
string type,
uint quantity,
ResultCallback< UserItem > callback )
inline

Add item to player inventory using inventoryConfigurationCode.

Parameters
userIduser to be process
inventoryConfigurationCodeinventory config code to be processed
sourceitem source to be processed
sourceItemIditem source id to be processed
typeitem type to be processed
quantityitem quantity to be processed
callbackReturns a Result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ SaveUserInventoryItem() [2/2]

void AccelByte.Server.ServerInventory.SaveUserInventoryItem ( string userId,
string inventoryConfigurationCode,
string source,
string sourceItemId,
string type,
uint quantity,
SaveUserInventoryItemOptionalParameters optionalParameters,
ResultCallback< UserItem > callback )
inline

Add item to player inventory using inventoryConfigurationCode.

Parameters
userIduser to be process
inventoryConfigurationCodeinventory config code to be processed
sourceitem source to be processed
sourceItemIditem source id to be processed
typeitem type to be processed
quantityitem quantity to be processed
optionalParametersoptional parameters to be processed
callbackReturns a Result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ SaveUserInventoryItemToInventory()

void AccelByte.Server.ServerInventory.SaveUserInventoryItemToInventory ( string inventoryId,
string userId,
string source,
string sourceItemId,
string type,
uint quantity,
SaveUserInventoryItemToInventoryOptionalParameters optionalParameters,
ResultCallback< UserItem > callback )
inline

Add item to player inventory using inventoryId.

Parameters
inventoryIdInventoryId to be process
userIduser to be process
sourceSource of item to be added, can be ECOMMERCE or OTHER
sourceItemIdItem id of item to be added
typeType of item to be added
quantityQuantity of item to be added
optionalParametersOptional parameters. Can be null.
callbackReturns a Result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ SyncUserEntitlements()

void AccelByte.Server.ServerInventory.SyncUserEntitlements ( string userId,
ResultCallback callback )
inline

Synchronizes user entitlement data to Inventory service.

Parameters
userIdId of user to sync data for
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ UpdateIntegrationConfiguration()

void AccelByte.Server.ServerInventory.UpdateIntegrationConfiguration ( string integrationConfigurationId,
ServerUpdateIntegrationConfigurationRequest request,
ResultCallback< ServerIntegrationConfiguration > callback )
inline

Updates an integration configuration via its id.

Parameters
integrationConfigurationIdId of integration configuration to update
requestData of integration configuration to update
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ UpdateIntegrationConfigurationStatus()

void AccelByte.Server.ServerInventory.UpdateIntegrationConfigurationStatus ( string integrationConfigurationId,
ServerUpdateIntegrationConfigurationStatusRequest request,
ResultCallback< ServerIntegrationConfiguration > callback )
inline

Updates an integration configuration's status via its id.

Parameters
integrationConfigurationIdId of integration configuration to update
requestData of integration configuration status to update
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ UpdateInventoryConfiguration()

void AccelByte.Server.ServerInventory.UpdateInventoryConfiguration ( string inventoryConfigurationId,
ServerUpdateInventoryConfigurationRequest request,
ResultCallback< InventoryConfiguration > callback )
inline

Updates inventory configuration data via its configuration Id.

Parameters
inventoryConfigurationIdId of inventory configuration to update
requestInventory configuration data to update
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ UpdateUserInventory()

void AccelByte.Server.ServerInventory.UpdateUserInventory ( string inventoryId,
ServerUpdateInventoryRequest request,
ResultCallback< UserInventory > callback )
inline

Update user inventory slot limit.

Parameters
inventoryIdInventory Id to be processed
requestDetailed data to be processed
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.

◆ ValidateUserInventoryCapacity()

void AccelByte.Server.ServerInventory.ValidateUserInventoryCapacity ( string userId,
ServerValidateUserInventoryCapacityRequest request,
ResultCallback callback )
inline

Validates the capacity of a user's inventory.

Parameters
userIdId of user to validate inventory capacity for
requestRequest data of inventory to validate
callbackReturns a result via callback when completed

Implements AccelByte.Server.Interface.IServerInventory.