AccelByte::Api::CloudStorage Class Reference

DEPRECATED.Cloud Storage API for storing binary data on the cloud. Each player has configurable slot(s) that controlled by admin. The configuration affects the amount of slot that owned by user and the allowed size for each slot (byte). More...

#include <AccelByteCloudStorageApi.h>

Inheritance diagram for AccelByte::Api::CloudStorage:

Public Member Functions
	CloudStorage (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	CloudStorage (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetAllSlots (THandler< TArray< FAccelByteModelsSlot > > const &OnSuccess, FErrorHandler const &OnError)
	DEPRECATED.This function gets list of slot(s) those owned by the player. Cloud Storage is DEPRECATED.
FAccelByteTaskWPtr	CreateSlot (TArray< uint8 > const &BinaryData, FString const &FileName, TArray< FString > const &Tags, FString const &Label, FString const &CustomAttribute, THandler< FAccelByteModelsSlot > const &OnSuccess, FHttpRequestProgressDelegate const &OnProgress, FErrorHandler const &OnError)
	DEPRECATED.This function creates a slot for an uploaded binary data. Cloud Storage is DEPRECATED.
FAccelByteTaskWPtr	UpdateSlot (FString const &SlotId, TArray< uint8 > const &BinaryData, FString const &FileName, TArray< FString > const &Tags, FString const &Label, FString const &CustomAttribute, THandler< FAccelByteModelsSlot > const &OnSuccess, FHttpRequestProgressDelegate const &OnProgress, FErrorHandler const &OnError)
	DEPRECATED.This function updates a stored slot. Cloud Storage is DEPRECATED.
FAccelByteTaskWPtr	UpdateSlotMetadata (FString const &SlotId, FString const &FileName, TArray< FString > const &Tags, FString const &Label, FString const &CustomAttribute, THandler< FAccelByteModelsSlot > const &OnSuccess, FHttpRequestProgressDelegate const &OnProgress, FErrorHandler const &OnError)
	DEPRECATED.This function updates stored slot's metadata. Cloud Storage is DEPRECATED.
FAccelByteTaskWPtr	UpdateSlotMetadata (FString const &SlotId, TArray< FString > const &Tags, FString const &Label, FString const &CustomAttribute, THandler< FAccelByteModelsSlot > const &OnSuccess, FHttpRequestProgressDelegate const &OnProgress, FErrorHandler const &OnError)
	DEPRECATED.This function updates stored slot's metadata. Cloud Storage is DEPRECATED.
FAccelByteTaskWPtr	GetSlot (FString SlotId, THandler< TArray< uint8 > > const &OnSuccess, FErrorHandler const &OnError)
	DEPRECATED.This function gets the data that stored in the slot. Cloud Storage is DEPRECATED.
FAccelByteTaskWPtr	DeleteSlot (FString const &SlotId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	DEPRECATED.This function delete the specified slot. Cloud Storage is DEPRECATED.
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

DEPRECATED.Cloud Storage API for storing binary data on the cloud. Each player has configurable slot(s) that controlled by admin. The configuration affects the amount of slot that owned by user and the allowed size for each slot (byte).

Member Function Documentation

CreateSlot()

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::CreateSlot	(	TArray< uint8 > const &	BinaryData,
		FString const &	FileName,
		TArray< FString > const &	Tags,
		FString const &	Label,
		FString const &	CustomAttribute,
		THandler< FAccelByteModelsSlot > const &	OnSuccess,
		FHttpRequestProgressDelegate const &	OnProgress,
		FErrorHandler const &	OnError )

DEPRECATED.This function creates a slot for an uploaded binary data. Cloud Storage is DEPRECATED.

Parameters

BinaryData	This is the data that will be stored in the slot.
FileName	This is the filename of the item that saved in the slot.
Tags	This is the tags that will be stored in the slot.
Label	This is the label that will be stored in the slot.
CustomAttribute	The custom attribute for the slot.
OnSuccess	This will be called when the operation succeeded. The result is const FAccelByteModelsSlot&.
OnProgress	This is delegate called per tick to update an Http request upload or download size progress.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

DeleteSlot()

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::DeleteSlot	(	FString const &	SlotId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

DEPRECATED.This function delete the specified slot. Cloud Storage is DEPRECATED.

Parameters

SlotId	Specify the slot.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetAllSlots()

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::GetAllSlots	(	THandler< TArray< FAccelByteModelsSlot > > const &	OnSuccess,
		FErrorHandler const &	OnError )

DEPRECATED.This function gets list of slot(s) those owned by the player. Cloud Storage is DEPRECATED.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is const TArray<FAccelByteModelsSlot>&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetSlot()

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::GetSlot	(	FString	SlotId,
		THandler< TArray< uint8 > > const &	OnSuccess,
		FErrorHandler const &	OnError )

DEPRECATED.This function gets the data that stored in the slot. Cloud Storage is DEPRECATED.

Parameters

SlotId	Specify the slot.
OnSuccess	This will be called when the operation succeeded. The result is const TArray<uint8>&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateSlot()

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::UpdateSlot	(	FString const &	SlotId,
		TArray< uint8 > const &	BinaryData,
		FString const &	FileName,
		TArray< FString > const &	Tags,
		FString const &	Label,
		FString const &	CustomAttribute,
		THandler< FAccelByteModelsSlot > const &	OnSuccess,
		FHttpRequestProgressDelegate const &	OnProgress,
		FErrorHandler const &	OnError )

DEPRECATED.This function updates a stored slot. Cloud Storage is DEPRECATED.

Parameters

SlotId	This is specific slot that will be updated.
BinaryData	This is the data that will be stored in the slot.
FileName	This is the filename of the item that saved in the slot.
Tags	This is the tags that will be stored in the slot.
Label	This is the label that will be stored in the slot.
CustomAttribute	The custom attribute for the slot.
OnSuccess	This will be called when the operation succeeded. The result is const FAccelByteModelsSlot&.
OnProgress	This is delegate called per tick to update an Http request upload or download size progress.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateSlotMetadata() [1/2]

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::UpdateSlotMetadata	(	FString const &	SlotId,
		FString const &	FileName,
		TArray< FString > const &	Tags,
		FString const &	Label,
		FString const &	CustomAttribute,
		THandler< FAccelByteModelsSlot > const &	OnSuccess,
		FHttpRequestProgressDelegate const &	OnProgress,
		FErrorHandler const &	OnError )

DEPRECATED.This function updates stored slot's metadata. Cloud Storage is DEPRECATED.

Parameters

SlotId	This is specific slot that will be updated.
FileName	This is the filename of the item that saved in the slot.
Tags	This is an array of tag that will be stored in the slot.
Label	This is the label that will be stored in the slot.
CustomAttribute	The custom attribute for the slot.
OnSuccess	This will be called when the operation succeeded. The result is const FAccelByteModelsSlot&.
OnProgress	This is delegate called per tick to update an Http request upload or download size progress.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateSlotMetadata() [2/2]

FAccelByteTaskWPtr AccelByte::Api::CloudStorage::UpdateSlotMetadata	(	FString const &	SlotId,
		TArray< FString > const &	Tags,
		FString const &	Label,
		FString const &	CustomAttribute,
		THandler< FAccelByteModelsSlot > const &	OnSuccess,
		FHttpRequestProgressDelegate const &	OnProgress,
		FErrorHandler const &	OnError )

DEPRECATED.This function updates stored slot's metadata. Cloud Storage is DEPRECATED.

Parameters

SlotId	This is specific slot that will be updated.
Tags	This is an array of tag that will be stored in the slot.
Label	This is the label that will be stored in the slot.
CustomAttribute	The custom attribute for the slot.
OnSuccess	This will be called when the operation succeeded. The result is const FAccelByteModelsSlot&.
OnProgress	This is delegate called per tick to update an Http request upload or download size progress.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.