Loading...
Searching...
No Matches
AccelByte::IAccelByteDataStorage Class Referenceabstract
Inheritance diagram for AccelByte::IAccelByteDataStorage:

Public Member Functions

virtual void Reset (const THandler< bool > &Result, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Reset an existing Table in the Storage.
virtual void DeleteItem (const FString &Key, const FVoidHandler OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Delete an Item in the Table.
virtual void SaveItemOverwiteEntireFile (FString Key, FString Item, const THandler< bool > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Insert Item to a file by overwrite operation.
virtual void SaveItem (const FString &Key, const TArray< uint8 > &Item, const THandler< bool > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Insert Item to the Key Value Table.
virtual void SaveItem (const FString &Key, const FString &Item, const THandler< bool > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Insert Item to the Key Value Table.
virtual void SaveItem (const FString &Key, const FJsonObjectWrapper &Item, const THandler< bool > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Insert Item to the Key Value Table.
virtual void GetItem (const FString &Key, const THandler< TPair< FString, TArray< uint8 > > > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Get an Item from the Key Value Table.
virtual void GetItem (const FString &Key, const THandler< TPair< FString, FString > > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Get an Item from the Key Value Table.
virtual void GetItem (const FString &Key, const THandler< TPair< FString, FJsonObjectWrapper > > &OnDone, const FString &TableName=TEXT("DefaultKeyValueTable"))=0
 Get an Item from the Key Value Table.
virtual void ConvertExistingCache (const FString &OldCacheFilename, const FString &NewCacheFilenameForTelemetry, const FString &NewCacheFilenameForGeneralPurpose)=0
 Change the old JSON-Array structure into new-line (
) separated JSON. Telemetry will be extracted from the old cache into a Telemetry specific cache. DeviceID & refresh token will be extracted as well into a GeneralPurpose cache.

Member Function Documentation

◆ ConvertExistingCache()

virtual void AccelByte::IAccelByteDataStorage::ConvertExistingCache ( const FString & OldCacheFilename,
const FString & NewCacheFilenameForTelemetry,
const FString & NewCacheFilenameForGeneralPurpose )
pure virtual

Change the old JSON-Array structure into new-line (
) separated JSON. Telemetry will be extracted from the old cache into a Telemetry specific cache. DeviceID & refresh token will be extracted as well into a GeneralPurpose cache.

Parameters
OldCacheFilenameThe targeted file that will be extracted
NewCacheFilenameForTelemetry
NewCacheFilenameForGeneralPurpose

Implemented in AccelByte::DataStorageBinaryFile.

◆ DeleteItem()

virtual void AccelByte::IAccelByteDataStorage::DeleteItem ( const FString & Key,
const FVoidHandler OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Delete an Item in the Table.

Parameters
KeyThe Key of the Item.
OnDoneThis will be called when the operation done.
TableNameoptional. The name of the table. Default will drop the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ GetItem() [1/3]

virtual void AccelByte::IAccelByteDataStorage::GetItem ( const FString & Key,
const THandler< TPair< FString, FJsonObjectWrapper > > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Get an Item from the Key Value Table.

Parameters
KeyThe Key of the Item to Get.
OnDoneThis will be called when the operation done. The result is Pair of a FString Key, and a FJsonObjectWrapper Value.
TableNameoptional. The name of the table. Default will get an item from the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ GetItem() [2/3]

virtual void AccelByte::IAccelByteDataStorage::GetItem ( const FString & Key,
const THandler< TPair< FString, FString > > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Get an Item from the Key Value Table.

Parameters
KeyThe Key of the Item to Get.
OnDoneThis will be called when the operation done. The result is Pair of a FString Key, and a FString Value.
TableNameoptional. The name of the table. Default will get an item from the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ GetItem() [3/3]

virtual void AccelByte::IAccelByteDataStorage::GetItem ( const FString & Key,
const THandler< TPair< FString, TArray< uint8 > > > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Get an Item from the Key Value Table.

Parameters
KeyThe Key of the Item to Get.
OnDoneThis will be called when the operation done. The result is Pair of a FString Key, and an array of uint8 Value.
TableNameoptional. The name of the table. Default will get an item from the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ Reset()

virtual void AccelByte::IAccelByteDataStorage::Reset ( const THandler< bool > & Result,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Reset an existing Table in the Storage.

Parameters
ResultThis will be called when the operation done. The result is bool.
TableNameoptional. The name of the table. Default will drop the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ SaveItem() [1/3]

virtual void AccelByte::IAccelByteDataStorage::SaveItem ( const FString & Key,
const FJsonObjectWrapper & Item,
const THandler< bool > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Insert Item to the Key Value Table.

Parameters
KeyThe Key of the Item.
ItemThe Data to be inserted to the Table. The Data would be a FJsonObjectWrapper.
OnDoneThis will be called when the operation done. The result is bool.
TableNameoptional. The name of the table. Default will insert an item to the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ SaveItem() [2/3]

virtual void AccelByte::IAccelByteDataStorage::SaveItem ( const FString & Key,
const FString & Item,
const THandler< bool > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Insert Item to the Key Value Table.

Parameters
KeyThe Key of the Item.
ItemThe Data to be inserted to the Table. The Data would be a FString.
OnDoneThis will be called when the operation done. The result is bool.
TableNameoptional. The name of the table. Default will insert an item to the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ SaveItem() [3/3]

virtual void AccelByte::IAccelByteDataStorage::SaveItem ( const FString & Key,
const TArray< uint8 > & Item,
const THandler< bool > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Insert Item to the Key Value Table.

Parameters
KeyThe Key of the Item.
ItemThe Data to be inserted to the Table. The Data would be an array of uint8.
OnDoneThis will be called when the operation done. The result is bool.
TableNameoptional. The name of the table. Default will insert an item to the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.

◆ SaveItemOverwiteEntireFile()

virtual void AccelByte::IAccelByteDataStorage::SaveItemOverwiteEntireFile ( FString Key,
FString Item,
const THandler< bool > & OnDone,
const FString & TableName = TEXT("DefaultKeyValueTable") )
pure virtual

Insert Item to a file by overwrite operation.

Parameters
KeyThe Key of the Item.
ItemThe Data to be inserted to the Table. The Data would be a FString.
OnDoneThis will be called when the operation done. The result is bool.
TableNameoptional. The name of the table. Default will insert an item to the default KeyValue table.

Implemented in AccelByte::DataStorageBinaryFile.