AccelByte.Server.ServerCloudSave Class Reference

Inheritance diagram for AccelByte.Server.ServerCloudSave:

Public Member Functions
void	SaveUserRecord (string userId, string key, Dictionary< string, object > recordRequest, ResultCallback callback)
	Save a user-level record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.
void	SaveUserRecord (string userId, string key, Dictionary< string, object > recordRequest, RecordSetBy setBy, bool isPublic, ResultCallback callback)
	Save a user-level record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.
void	GetUserRecord (string userId, string key, ResultCallback< UserRecord > callback)
	Get a record (arbitrary JSON data) by its key in user-level.
void	ReplaceUserRecord (string userId, string key, Dictionary< string, object > recordRequest, ResultCallback callback)
	Replace a record in user-level. If the record doesn't exist, it will create and save the record. If already exists, it will replace the existing one.
void	ReplaceUserRecord (string userId, string key, Dictionary< string, object > recordRequest, RecordSetBy setBy, bool isPublic, ResultCallback callback)
	Replace a record in user-level. If the record doesn't exist, it will create and save the record. If already exists, it will replace the existing one.
void	DeleteUserRecord (string userId, string key, ResultCallback callback)
	Delete a record under the given key in user-level.
void	SaveGameRecord (string key, Dictionary< string, object > recordRequest, GameRecordMetadataOptionalParams optionalParams, ResultCallback< GameRecord > callback)
	Save a game record.If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.
void	DeleteGameRecord (string key, ResultCallback callback)
	Delete a game record under the given key.
void	ReplaceGameRecord (string key, Dictionary< string, object > recordRequest, GameRecordMetadataOptionalParams optionalParams, ResultCallback< GameRecord > callback)
	Replace a game record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.
void	ReplaceGameRecordCheckLatest (string key, DateTime lastUpdated, Dictionary< string, object > recordRequest, ResultCallback callback)
	Replace a game record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.
void	RetrieveGameRecordsKey (ResultCallback< GameRecordList > callback, string query="{}", int offset=0, int limit=20)
	Get a record (arbitrary JSON data) by its key in user-level.
void	GetGameRecords (string key, ResultCallback< GameRecord > callback)
	Get a record by its key in namespace-level.
void	CreateAdminGameRecord (string key, Dictionary< string, object > recordRequest, AdminRecordMetadataOptionalParams optionalParams, ResultCallback< AdminGameRecord > callback)
	Create new admin game record or append the existing admin game record.
void	QueryAdminGameRecordsByKey (string key, ResultCallback< AdminGameRecord > callback)
	Get a record by its key in namespace-level.
void	BulkQueryAdminGameRecordsByKey (string[] keys, ResultCallback< BulkAdminGameRecordResponse > callback)
	Get an array of records by their keys in namespace-level.
void	QueryAdminGameRecordKeys (ResultCallback< GameRecordList > callback, int limit=20, int offset=0)
	Retrieve list of records key by namespace.
void	ReplaceAdminGameRecord (string key, Dictionary< string, object > recordRequest, AdminRecordMetadataOptionalParams optionalParams, ResultCallback< AdminGameRecord > callback)
	Create new admin game record or replace the existing admin game record.
void	DeleteAdminGameRecord (string key, ResultCallback callback)
void	CreateAdminUserRecord (string key, string userId, Dictionary< string, object > recordRequest, ResultCallback< AdminUserRecord > callback)
	Create new admin user record or append the existing admin user record.
void	QueryAdminUserRecordsByKey (string key, string userId, ResultCallback< AdminUserRecord > callback)
	Query admin user records by Key.
void	QueryAdminUserRecordKeys (string userId, ResultCallback< PaginatedGetAdminUserRecordKeys > callback, int limit=20, int offset=0)
	Query admin user record Keys.
void	ReplaceAdminUserRecord (string key, string userId, Dictionary< string, object > recordRequest, ResultCallback< AdminUserRecord > callback)
	Replace admin user record.
void	DeleteAdminUserRecord (string key, string userId, ResultCallback callback)
void	DeleteAdminGameRecordTTLConfig (string key, ResultCallback callback)
	Delete the TTLConfig for a specific Admin Game Record by its key.
void	DeleteGameRecordTTLConfig (string key, ResultCallback callback)
	Delete the TTLConfig for a specific Game Record by its key.

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

Member Function Documentation

BulkQueryAdminGameRecordsByKey()

void AccelByte.Server.ServerCloudSave.BulkQueryAdminGameRecordsByKey ( string[] keys, ResultCallback< BulkAdminGameRecordResponse > callback )

inline

Get an array of records by their keys in namespace-level.

Parameters

keys	Array of keys of record to get. Maximum value of 20.
callback	Returns a Result via callback when completed.

CreateAdminGameRecord()

void AccelByte.Server.ServerCloudSave.CreateAdminGameRecord ( string key, Dictionary< string, object > recordRequest, AdminRecordMetadataOptionalParams optionalParams, ResultCallback< AdminGameRecord > callback )

inline

Create new admin game record or append the existing admin game record.

Parameters

key	Key of record
recordRequest	The request of the record with JSON formatted.
optionalParams	Optional params to set metadata (Can be null)
callback	Returns a Result via callback when completed

CreateAdminUserRecord()

void AccelByte.Server.ServerCloudSave.CreateAdminUserRecord ( string key, string userId, Dictionary< string, object > recordRequest, ResultCallback< AdminUserRecord > callback )

inline

Create new admin user record or append the existing admin user record.

Parameters

key	Key of record
userId	UserId of the record owner.
recordRequest	The request of the record with JSON formatted.
callback	Returns a Result via callback when completed

DeleteAdminGameRecord()

void AccelByte.Server.ServerCloudSave.DeleteAdminGameRecord ( string key, ResultCallback callback )

inline

Parameters

key	Key of record
callback	Returns a Result via callback when completed

DeleteAdminGameRecordTTLConfig()

void AccelByte.Server.ServerCloudSave.DeleteAdminGameRecordTTLConfig ( string key, ResultCallback callback )

inline

Delete the TTLConfig for a specific Admin Game Record by its key.

Parameters

key	Key of the admin game record.
callback	Returns a result via callback when completed.

DeleteGameRecord()

void AccelByte.Server.ServerCloudSave.DeleteGameRecord ( string key, ResultCallback callback )

inline

Delete a game record under the given key.

Parameters

key	Key of record
callback	Returns a Result via callback when completed

DeleteGameRecordTTLConfig()

void AccelByte.Server.ServerCloudSave.DeleteGameRecordTTLConfig ( string key, ResultCallback callback )

inline

Delete the TTLConfig for a specific Game Record by its key.

Parameters

key	Key of the game record.
callback	Returns a result via callback when completed.

DeleteUserRecord()

void AccelByte.Server.ServerCloudSave.DeleteUserRecord ( string userId, string key, ResultCallback callback )

inline

Delete a record under the given key in user-level.

Parameters

userId	Targeted user ID
key	Key of record
callback	Returns a Result via callback when completed

GetGameRecords()

void AccelByte.Server.ServerCloudSave.GetGameRecords ( string key, ResultCallback< GameRecord > callback )

inline

Get a record by its key in namespace-level.

Parameters

key	The key of the record
callback

GetUserRecord()

void AccelByte.Server.ServerCloudSave.GetUserRecord ( string userId, string key, ResultCallback< UserRecord > callback )

inline

Get a record (arbitrary JSON data) by its key in user-level.

Parameters

userId	Targeted user ID
key	Key of record
callback	Returns a Result that contains UserRecord via callback when completed

QueryAdminGameRecordKeys()

void AccelByte.Server.ServerCloudSave.QueryAdminGameRecordKeys ( ResultCallback< GameRecordList > callback, int limit = 20, int offset = 0 )

inline

Retrieve list of records key by namespace.

Parameters

callback	Returns a Result via callback when completed
limit	The limit of the keys result.
offset	Distance between the beginning of the data list and a given point

QueryAdminGameRecordsByKey()

void AccelByte.Server.ServerCloudSave.QueryAdminGameRecordsByKey ( string key, ResultCallback< AdminGameRecord > callback )

inline

Get a record by its key in namespace-level.

Parameters

key	Key of record
callback	Returns a Result via callback when completed

QueryAdminUserRecordKeys()

void AccelByte.Server.ServerCloudSave.QueryAdminUserRecordKeys ( string userId, ResultCallback< PaginatedGetAdminUserRecordKeys > callback, int limit = 20, int offset = 0 )

inline

Query admin user record Keys.

Parameters

userId	UserId of the record owner.
callback	Returns a Result via callback when completed
limit	The limit of the keys result.
offset	Distance between the beginning of the data list and a given point

QueryAdminUserRecordsByKey()

void AccelByte.Server.ServerCloudSave.QueryAdminUserRecordsByKey ( string key, string userId, ResultCallback< AdminUserRecord > callback )

inline

Query admin user records by Key.

Parameters

key	Key of record
userId	UserId of the record owner.
callback	Returns a Result via callback when completed

ReplaceAdminGameRecord()

void AccelByte.Server.ServerCloudSave.ReplaceAdminGameRecord ( string key, Dictionary< string, object > recordRequest, AdminRecordMetadataOptionalParams optionalParams, ResultCallback< AdminGameRecord > callback )

inline

Create new admin game record or replace the existing admin game record.

Parameters

key	Key of record
recordRequest	The request of the record with JSON formatted.
optionalParams	Optional params to set metadata (Can be null)
callback	Returns a Result via callback when completed

ReplaceAdminUserRecord()

void AccelByte.Server.ServerCloudSave.ReplaceAdminUserRecord ( string key, string userId, Dictionary< string, object > recordRequest, ResultCallback< AdminUserRecord > callback )

inline

Replace admin user record.

Parameters

key	Key of record
userId	UserId of the record owner.
recordRequest	The request of the record with JSON formatted.
callback	Returns a Result via callback when completed

ReplaceGameRecord()

void AccelByte.Server.ServerCloudSave.ReplaceGameRecord ( string key, Dictionary< string, object > recordRequest, GameRecordMetadataOptionalParams optionalParams, ResultCallback< GameRecord > callback )

inline

Replace a game record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.

Parameters

key	Key of record
recordRequest	The request of the record to be formatted as JSON
optionalParams	Optional params to set metadata (Can be null)
callback	Returns a GameRecord result via callback when completed

ReplaceGameRecordCheckLatest()

void AccelByte.Server.ServerCloudSave.ReplaceGameRecordCheckLatest ( string key, DateTime lastUpdated, Dictionary< string, object > recordRequest, ResultCallback callback )

inline

Replace a game record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.

Parameters

key	Key of record
lastUpdated	Last updated
recordRequest	The request of the record with JSON formatted.
callback	Returns a Result via callback when completed

ReplaceUserRecord() [1/2]

void AccelByte.Server.ServerCloudSave.ReplaceUserRecord ( string userId, string key, Dictionary< string, object > recordRequest, RecordSetBy setBy, bool isPublic, ResultCallback callback )

inline

Replace a record in user-level. If the record doesn't exist, it will create and save the record. If already exists, it will replace the existing one.

Parameters

userId	Targeted user ID
key	Key of record
recordRequest	The request of the record with JSON formatted.
setBy	Indicate which party that could modify the player record.
isPublic	Indicate whether the player record is a public record or not.
callback	Returns a Result via callback when completed

ReplaceUserRecord() [2/2]

void AccelByte.Server.ServerCloudSave.ReplaceUserRecord ( string userId, string key, Dictionary< string, object > recordRequest, ResultCallback callback )

inline

Replace a record in user-level. If the record doesn't exist, it will create and save the record. If already exists, it will replace the existing one.

Parameters

userId	Targeted user ID
key	Key of record
recordRequest	The request of the record with JSON formatted.
callback	Returns a Result via callback when completed

RetrieveGameRecordsKey()

void AccelByte.Server.ServerCloudSave.RetrieveGameRecordsKey ( ResultCallback< GameRecordList > callback, string query = "{}", int offset = 0, int limit = 20 )

inline

Get a record (arbitrary JSON data) by its key in user-level.

Parameters

callback

Parameters query list of GameRecordKey offset Offset The offset of GameRecord result. Default value is 0. limit limit The limit of GameRecord result. Default value is 20. Returns a Result that contains UserRecord via callback when completed

SaveGameRecord()

void AccelByte.Server.ServerCloudSave.SaveGameRecord ( string key, Dictionary< string, object > recordRequest, GameRecordMetadataOptionalParams optionalParams, ResultCallback< GameRecord > callback )

inline

Save a game record.If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.

Parameters

key	Key of record
recordRequest	The request of the record to be formatted as JSON
optionalParams	Optional params to set metadata (Can be null)
callback	Returns a GameRecord result via callback when completed

SaveUserRecord() [1/2]

void AccelByte.Server.ServerCloudSave.SaveUserRecord ( string userId, string key, Dictionary< string, object > recordRequest, RecordSetBy setBy, bool isPublic, ResultCallback callback )

inline

Save a user-level record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.

Parameters

userId	Targeted user ID
key	Key of record
recordRequest	The request of the record with JSON formatted.
setBy	Indicate which party that could modify the player record
isPublic	Indicate whether the player record is a public record or not
callback	Returns a Result via callback when completed

SaveUserRecord() [2/2]

void AccelByte.Server.ServerCloudSave.SaveUserRecord ( string userId, string key, Dictionary< string, object > recordRequest, ResultCallback callback )

inline

Save a user-level record. If the record doesn't exist, it will create and save the record, if already exists, it will append to the existing one.

Parameters

userId	Targeted user ID
key	Key of record
recordRequest	The request of the record with JSON formatted.
callback	Returns a Result via callback when completed