Interface ICustomDataService

Namespace: Unity.Services.CloudSave.Internal

Assembly: Unity.Services.CloudSave.dll

Syntax

public interface ICustomDataService

Methods

ListAllKeysAsync(string)

Returns all keys stored in Cloud Save for the specified custom data ID. Throws a CloudSaveException with a reason code and explanation of what happened.

Declaration

Task<List<ItemKey>> ListAllKeysAsync(string customDataID)

Parameters

Type	Name	Description
string	customDataID

Returns

Type	Description
Task<List<ItemKey>>	A list of keys and their metadata as stored in the server for the logged in player.

Exceptions

Type	Condition
CloudSaveException	Thrown if request is unsuccessful.
CloudSaveValidationException	Thrown if the service returned validation error.
CloudSaveRateLimitedException	Thrown if the service returned rate limited error.

LoadAllAsync(string)

Downloads all items from Cloud Save for the custom data ID. There is no client validation in place. Throws a CloudSaveException with a reason code and explanation of what happened.

Declaration

Task<Dictionary<string, Item>> LoadAllAsync(string customDataID)

Parameters

Type	Name	Description
string	customDataID

Returns

Type	Description
Task<Dictionary<string, Item>>	The dictionary of all key-value pairs that represents the current state of data on the server

Exceptions

Type	Condition
CloudSaveException	Thrown if request is unsuccessful.
CloudSaveValidationException	Thrown if the service returned validation error.
CloudSaveRateLimitedException	Thrown if the service returned rate limited error.

LoadAsync(string, ISet<string>)

Downloads items from Cloud Save for the custom data ID and keys provided. There is no client validation in place. Throws a CloudSaveException with a reason code and explanation of what happened.

Declaration

Task<Dictionary<string, Item>> LoadAsync(string customDataID, ISet<string> keys)

Parameters

Type	Name	Description
string	customDataID
ISet<string>	keys

Returns

Type	Description
Task<Dictionary<string, Item>>	The dictionary of all key-value pairs that represents the current state of data on the server

Exceptions

Type	Condition
CloudSaveException	Thrown if request is unsuccessful.
CloudSaveValidationException	Thrown if the service returned validation error.
CloudSaveRateLimitedException	Thrown if the service returned rate limited error.

QueryAsync(Query, QueryOptions)

Queries indexed custom data from Cloud Save, and returns the requested keys for matching items. Throws a CloudSaveException with a reason code and explanation of what happened.

Declaration

Task<List<EntityData>> QueryAsync(Query query, QueryOptions options = null)

Parameters

Type	Name	Description
Query	query	The query conditions to apply, including field filters and sort orders
QueryOptions	options	Options to modify the behavior of the method

Returns

Type	Description
Task<List<EntityData>>	The dictionary of all key-value pairs that represents the current state of data on the server including their write locks

Exceptions

Type	Condition
CloudSaveException	Thrown if request is unsuccessful.
CloudSaveValidationException	Thrown if the service returned validation error.
CloudSaveRateLimitedException	Thrown if the service returned rate limited error.