Provide APIs to access Inventory service. More...

#include <AccelByteInventoryApi.h>

Inheritance diagram for AccelByte::Api::Inventory:

Public Member Functions
	Inventory (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Inventory (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetInventoryConfigurations (THandler< FAccelByteModelsInventoryConfigurationsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteInventoryConfigurationSortBy SortBy=EAccelByteInventoryConfigurationSortBy::CREATED_AT_DESC, int32 Limit=20, int32 Offset=0, FString const &InventoryConfigurationCode=TEXT(""))
	Get a list of inventory configurations in a namespace.
FAccelByteTaskWPtr	GetInventoryTags (THandler< FAccelByteModelsInventoryTagPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteInventoryUtilitiesSortBy SortBy=EAccelByteInventoryUtilitiesSortBy::CREATED_AT_DESC, int32 Limit=20, int32 Offset=0)
	Get a list of inventory tags in a namespace.
FAccelByteTaskWPtr	GetUserInventories (THandler< FAccelByteModelsUserInventoriesPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteUserInventoriesSortBy SortBy=EAccelByteUserInventoriesSortBy::CREATED_AT_DESC, int32 Limit=20, int32 Offset=0, FString const &InventoryConfigurationCode=TEXT(""))
	Get a list of user inventories in a namespace.
FAccelByteTaskWPtr	GetItemTypes (THandler< FAccelByteModelsItemTypePagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteInventoryUtilitiesSortBy SortBy=EAccelByteInventoryUtilitiesSortBy::CREATED_AT_DESC, int32 Limit=20, int32 Offset=0)
	Get a list of item types in a namespace.
FAccelByteTaskWPtr	GetUserInventoryAllItems (FString const &InventoryId, THandler< FAccelByteModelsUserItemsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteUserItemsSortBy SortBy=EAccelByteUserItemsSortBy::CREATED_AT_DESC, int32 Limit=20, int32 Offset=0, FString const &SourceItemId=TEXT(""), FString const &Tags=TEXT(""))
	Get a list of user items from specific user inventory.
FAccelByteTaskWPtr	GetUserInventoryItem (FString const &InventoryId, FString const &SlotId, FString const &SourceItemId, THandler< FAccelByteModelsUserItemResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get a specific item from specific user inventory.
FAccelByteTaskWPtr	BulkUpdateInventoryItems (FString const &InventoryId, TArray< FAccelByteModelsUpdateUserInventoryItemRequest > const &UpdatedItemsRequest, THandler< TArray< FAccelByteModelsUpdateUserInventoryItemResponse > > const &OnSuccess, FErrorHandler const &OnError)
	Bulk update user inventory items.
FAccelByteTaskWPtr	BulkDeleteInventoryItems (FString const &InventoryId, TArray< FAccelByteModelsDeleteUserInventoryItemsRequest > const &DeletedItemsRequest, THandler< TArray< FAccelByteModelsDeleteUserInventoryItemResponse > > const &OnSuccess, FErrorHandler const &OnError)
	Bulk delete user inventory items.
FAccelByteTaskWPtr	MoveItemsBetweenInventories (FString const &TargetInventoryId, FAccelByteModelsMoveUserItemsBetweenInventoriesRequest const &MoveItemsRequest, THandler< FAccelByteModelsMoveUserItemsBetweenInventoriesResponse > const &OnSuccess, FErrorHandler const &OnError)
	Bulk delete user inventory items.
FAccelByteTaskWPtr	ConsumeUserInventoryItem (FString const &InventoryId, FAccelByteModelsConsumeUserItemsRequest const &ConsumedItemsRequest, THandler< FAccelByteModelsUserItemResponse > const &OnSuccess, FErrorHandler const &OnError)
	Consume user inventory item.
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Detailed Description

Provide APIs to access Inventory service.

Member Function Documentation

◆ BulkDeleteInventoryItems()

FAccelByteTaskWPtr AccelByte::Api::Inventory::BulkDeleteInventoryItems	(	FString const &	InventoryId,
		TArray< FAccelByteModelsDeleteUserInventoryItemsRequest > const &	DeletedItemsRequest,
		THandler< TArray< FAccelByteModelsDeleteUserInventoryItemResponse > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk delete user inventory items.

Parameters

InventoryId	The id of user's inventory.
DeletedItemsRequest	An array of items that will be deleted.
OnSuccess	This will be called when the operation succeeded. The result is TArray<FAccelByteModelsDeleteUserInventoryItemResponse>.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkUpdateInventoryItems()

FAccelByteTaskWPtr AccelByte::Api::Inventory::BulkUpdateInventoryItems	(	FString const &	InventoryId,
		TArray< FAccelByteModelsUpdateUserInventoryItemRequest > const &	UpdatedItemsRequest,
		THandler< TArray< FAccelByteModelsUpdateUserInventoryItemResponse > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk update user inventory items.

Parameters

InventoryId	The id of user's inventory.
UpdatedItemsRequest	An array of items that will be updated.
OnSuccess	This will be called when the operation succeeded. The result is TArray<FAccelByteModelsUpdateUserInventoryItemResponse>.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ConsumeUserInventoryItem()

FAccelByteTaskWPtr AccelByte::Api::Inventory::ConsumeUserInventoryItem	(	FString const &	InventoryId,
		FAccelByteModelsConsumeUserItemsRequest const &	ConsumedItemsRequest,
		THandler< FAccelByteModelsUserItemResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Consume user inventory item.

Parameters

InventoryId	The id of user's inventory.
ConsumedItemsRequest	Variable contains an array of items that will be consumed.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserItemResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetInventoryConfigurations()

FAccelByteTaskWPtr AccelByte::Api::Inventory::GetInventoryConfigurations	(	THandler< FAccelByteModelsInventoryConfigurationsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteInventoryConfigurationSortBy	SortBy = EAccelByteInventoryConfigurationSortBy::CREATED_AT_DESC,
		int32	Limit = 20,
		int32	Offset = 0,
		FString const &	InventoryConfigurationCode = TEXT("") )

Get a list of inventory configurations in a namespace.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsInventoryConfigurationsPagingResponse.
OnError	This will be called when the operation failed.
SortBy	The sorting criteria for the list of inventory configurations. Value: createdAt, updatedAt, code, maxItems. default = createdAt:desc.
Limit	Number of content per page to retrieve. Default value : 20
Offset	Number of page to retrieve. Default value : 0
InventoryConfigurationCode	The code of a certain inventory configuration.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetInventoryTags()

FAccelByteTaskWPtr AccelByte::Api::Inventory::GetInventoryTags	(	THandler< FAccelByteModelsInventoryTagPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteInventoryUtilitiesSortBy	SortBy = EAccelByteInventoryUtilitiesSortBy::CREATED_AT_DESC,
		int32	Limit = 20,
		int32	Offset = 0 )

Get a list of inventory tags in a namespace.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsInventoryTagPagingResponse.
OnError	This will be called when the operation failed.
SortBy	The sorting criteria for the list of inventory types. Value: createdAt, name. default = createdAt:desc.
Limit	Number of content per page to retrieve. Default value : 20
Offset	Number of page to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetItemTypes()

FAccelByteTaskWPtr AccelByte::Api::Inventory::GetItemTypes	(	THandler< FAccelByteModelsItemTypePagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteInventoryUtilitiesSortBy	SortBy = EAccelByteInventoryUtilitiesSortBy::CREATED_AT_DESC,
		int32	Limit = 20,
		int32	Offset = 0 )

Get a list of item types in a namespace.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsItemTypePagingResponse.
OnError	This will be called when the operation failed.
SortBy	The sorting criteria for the list of inventory types. Value: createdAt, name. default = createdAt:desc.
Limit	Number of content per page to retrieve. Default value : 20
Offset	Number of page to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserInventories()

FAccelByteTaskWPtr AccelByte::Api::Inventory::GetUserInventories	(	THandler< FAccelByteModelsUserInventoriesPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteUserInventoriesSortBy	SortBy = EAccelByteUserInventoriesSortBy::CREATED_AT_DESC,
		int32	Limit = 20,
		int32	Offset = 0,
		FString const &	InventoryConfigurationCode = TEXT("") )

Get a list of user inventories in a namespace.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserInventoriesPagingResponse.
OnError	This will be called when the operation failed.
SortBy	The sorting criteria for the list of user inventories. Value: createdAt, updatedAt. default = createdAt:desc.
Limit	Number of content per page to retrieve. Default value : 20
Offset	Number of page to retrieve. Default value : 0
InventoryConfigurationCode	The code of a certain inventory configuration.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserInventoryAllItems()

FAccelByteTaskWPtr AccelByte::Api::Inventory::GetUserInventoryAllItems	(	FString const &	InventoryId,
		THandler< FAccelByteModelsUserItemsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteUserItemsSortBy	SortBy = EAccelByteUserItemsSortBy::CREATED_AT_DESC,
		int32	Limit = 20,
		int32	Offset = 0,
		FString const &	SourceItemId = TEXT(""),
		FString const &	Tags = TEXT("") )

Get a list of user items from specific user inventory.

Parameters

InventoryId	The id of user's inventory.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserItemsPagingResponse.
OnError	This will be called when the operation failed.
SortBy	The sorting criteria for the list of inventory types. Value: createdAt, updatedAt, quantity. default = createdAt:desc.
Limit	Number of content per page to retrieve. Default value : 20
Offset	Number of page to retrieve. Default value : 0
SourceItemId	The id of source item.
Tags	The Tags of user's item.
Quantity	The preferred minimum quantity of an item.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserInventoryItem()

FAccelByteTaskWPtr AccelByte::Api::Inventory::GetUserInventoryItem	(	FString const &	InventoryId,
		FString const &	SlotId,
		FString const &	SourceItemId,
		THandler< FAccelByteModelsUserItemResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a specific item from specific user inventory.

Parameters

InventoryId	The id of user's inventory.
SlotId	The id of item slot.
SourceItemId	The id of item source.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserItemResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ MoveItemsBetweenInventories()

FAccelByteTaskWPtr AccelByte::Api::Inventory::MoveItemsBetweenInventories	(	FString const &	TargetInventoryId,
		FAccelByteModelsMoveUserItemsBetweenInventoriesRequest const &	MoveItemsRequest,
		THandler< FAccelByteModelsMoveUserItemsBetweenInventoriesResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk delete user inventory items.

Parameters

TargetInventoryId	The target id of user's inventory.
MoveItemsRequest	Variable contains an array of items that will be moved as well as the inventory destination id.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsMoveUserItemsBetweenInventoriesResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BulkDeleteInventoryItems()

◆ BulkUpdateInventoryItems()

◆ ConsumeUserInventoryItem()

◆ GetInventoryConfigurations()

◆ GetInventoryTags()

◆ GetItemTypes()

◆ GetUserInventories()

◆ GetUserInventoryAllItems()

◆ GetUserInventoryItem()

◆ MoveItemsBetweenInventories()