Interface ICloudSaveDataApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.CloudSave

Assembly: Unity.Services.Apis.dll

Syntax

public interface ICloudSaveDataApi : IApiAccessor

Methods

DeleteCustomItem(string, string, string, string, CancellationToken)

Delete Custom Item

Declaration

ApiOperation DeleteCustomItem(string key, string projectId, string customId, string writeLock = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	key	Item key.
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
string	writeLock	Enforces conflict checking when deleting an existing data item. Omitting this field ignores write conflicts. When present, an error response will be returned if the writeLock in the request does not match the stored writeLock. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteCustomItems(string, string, CancellationToken)

Delete Custom Items

Declaration

ApiOperation DeleteCustomItems(string projectId, string customId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteItem(string, string, string, string, CancellationToken)

Delete Player Item

Declaration

ApiOperation DeleteItem(string key, string projectId, string playerId, string writeLock = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	key	Item key.
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
string	writeLock	Enforces conflict checking when deleting an existing data item. Omitting this field ignores write conflicts. When present, an error response will be returned if the writeLock in the request does not match the stored writeLock. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteItems(string, string, CancellationToken)

Delete Player Items

Declaration

ApiOperation DeleteItems(string projectId, string playerId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeletePrivateCustomItem(string, string, string, string, CancellationToken)

Delete Private Custom Item

Declaration

ApiOperation DeletePrivateCustomItem(string key, string projectId, string customId, string writeLock = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	key	Item key.
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
string	writeLock	Enforces conflict checking when deleting an existing data item. Omitting this field ignores write conflicts. When present, an error response will be returned if the writeLock in the request does not match the stored writeLock. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeletePrivateCustomItems(string, string, CancellationToken)

Delete Private Custom Items

Declaration

ApiOperation DeletePrivateCustomItems(string projectId, string customId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteProtectedItem(string, string, string, string, CancellationToken)

Delete Protected Player Item

Declaration

ApiOperation DeleteProtectedItem(string key, string projectId, string playerId, string writeLock = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	key	Item key.
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
string	writeLock	Enforces conflict checking when deleting an existing data item. Omitting this field ignores write conflicts. When present, an error response will be returned if the writeLock in the request does not match the stored writeLock. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteProtectedItems(string, string, CancellationToken)

Delete Protected Player Items

Declaration

ApiOperation DeleteProtectedItems(string projectId, string playerId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeletePublicItem(string, string, string, string, CancellationToken)

Delete Public Player Item

Declaration

ApiOperation DeletePublicItem(string key, string projectId, string playerId, string writeLock = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	key	Item key.
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
string	writeLock	Enforces conflict checking when deleting an existing data item. Omitting this field ignores write conflicts. When present, an error response will be returned if the writeLock in the request does not match the stored writeLock. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeletePublicItems(string, string, CancellationToken)

Delete Public Player Items

Declaration

ApiOperation DeletePublicItems(string projectId, string playerId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetCustomItems(string, string, List<string>, string, CancellationToken)

Get Custom Items

Declaration

ApiOperation<GetItemsResponse> GetCustomItems(string projectId, string customId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
List<string>	keys	The keys to retrieve, in exploded form style, e.g. keys=KEY1&keys=KEY2&keys=KEY3. (optional)
string	after	The key after which to retrieve the next page of keys. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetItemsResponse>	The operation

GetCustomKeys(string, string, string, CancellationToken)

Get Custom Keys

Declaration

ApiOperation<GetKeysResponse> GetCustomKeys(string projectId, string customId, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
string	after	Returns the page of results after the key specified. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetKeysResponse>	The operation

GetItems(string, string, List<string>, string, CancellationToken)

Get Player Items

Declaration

ApiOperation<GetItemsResponse> GetItems(string projectId, string playerId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
List<string>	keys	The keys to retrieve, in exploded form style, e.g. keys=KEY1&keys=KEY2&keys=KEY3. (optional)
string	after	The key after which to retrieve the next page of keys. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetItemsResponse>	The operation

GetKeys(string, string, string, CancellationToken)

Get Player Keys

Declaration

ApiOperation<GetKeysResponse> GetKeys(string projectId, string playerId, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
string	after	Returns the page of results after the key specified. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetKeysResponse>	The operation

GetPrivateCustomItems(string, string, List<string>, string, CancellationToken)

Get Private Custom Items

Declaration

ApiOperation<GetItemsResponse> GetPrivateCustomItems(string projectId, string customId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
List<string>	keys	The keys to retrieve, in exploded form style, e.g. keys=KEY1&keys=KEY2&keys=KEY3. (optional)
string	after	The key after which to retrieve the next page of keys. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetItemsResponse>	The operation

GetPrivateCustomKeys(string, string, string, CancellationToken)

Get Private Custom Keys

Declaration

ApiOperation<GetKeysResponse> GetPrivateCustomKeys(string projectId, string customId, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
string	after	Returns the page of results after the key specified. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetKeysResponse>	The operation

GetProtectedItems(string, string, List<string>, string, CancellationToken)

Get Protected Player Items

Declaration

ApiOperation<GetItemsResponse> GetProtectedItems(string projectId, string playerId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
List<string>	keys	The keys to retrieve, in exploded form style, e.g. keys=KEY1&keys=KEY2&keys=KEY3. (optional)
string	after	The key after which to retrieve the next page of keys. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetItemsResponse>	The operation

GetProtectedKeys(string, string, string, CancellationToken)

Get Protected Player Keys

Declaration

ApiOperation<GetKeysResponse> GetProtectedKeys(string projectId, string playerId, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
string	after	Returns the page of results after the key specified. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetKeysResponse>	The operation

GetPublicItems(string, string, List<string>, string, CancellationToken)

Get Public Player Items

Declaration

ApiOperation<GetItemsResponse> GetPublicItems(string projectId, string playerId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
List<string>	keys	The keys to retrieve, in exploded form style, e.g. keys=KEY1&keys=KEY2&keys=KEY3. (optional)
string	after	The key after which to retrieve the next page of keys. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetItemsResponse>	The operation

GetPublicKeys(string, string, string, CancellationToken)

Get Public Player Keys

Declaration

ApiOperation<GetKeysResponse> GetPublicKeys(string projectId, string playerId, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
string	after	Returns the page of results after the key specified. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetKeysResponse>	The operation

QueryDefaultCustomData(string, QueryIndexBody, CancellationToken)

Query Default Custom Data

Declaration

ApiOperation<QueryIndexResponse> QueryDefaultCustomData(string projectId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
QueryIndexBody	queryIndexBody	Query object with an array of conditions to query the data with. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QueryIndexResponse>	The operation

QueryDefaultPlayerData(string, QueryIndexBody, CancellationToken)

Query Default Player Data

Declaration

ApiOperation<QueryIndexResponse> QueryDefaultPlayerData(string projectId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
QueryIndexBody	queryIndexBody	Query object with an array of conditions to query the data with. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QueryIndexResponse>	The operation

QueryPrivateCustomData(string, QueryIndexBody, CancellationToken)

Query Private Custom Data

Declaration

ApiOperation<QueryIndexResponse> QueryPrivateCustomData(string projectId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
QueryIndexBody	queryIndexBody	Query object with an array of conditions to query the data with. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QueryIndexResponse>	The operation

QueryProtectedPlayerData(string, QueryIndexBody, CancellationToken)

Query Protected Player Data

Declaration

ApiOperation<QueryIndexResponse> QueryProtectedPlayerData(string projectId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
QueryIndexBody	queryIndexBody	Query object with an array of conditions to query the data with. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QueryIndexResponse>	The operation

QueryPublicPlayerData(string, QueryIndexBody, CancellationToken)

Query Public Player Data

Declaration

ApiOperation<QueryIndexResponse> QueryPublicPlayerData(string projectId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
QueryIndexBody	queryIndexBody	Query object with an array of conditions to query the data with. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QueryIndexResponse>	The operation

SetCustomItem(string, string, SetItemBody, CancellationToken)

Set Custom Item

Declaration

ApiOperation<SetItemResponse> SetCustomItem(string projectId, string customId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
SetItemBody	setItemBody	Add a data item to store for a custom ID. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemResponse>	The operation

SetCustomItemBatch(string, string, SetItemBatchBody, CancellationToken)

Set Custom Item Batch

Declaration

ApiOperation<SetItemBatchResponse> SetCustomItemBatch(string projectId, string customId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
SetItemBatchBody	setItemBatchBody	Set batch data items for a custom ID. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemBatchResponse>	The operation

SetItem(string, string, SetItemBody, CancellationToken)

Set Player Item

Declaration

ApiOperation<SetItemResponse> SetItem(string projectId, string playerId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
SetItemBody	setItemBody	Add a data item to store for a player. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemResponse>	The operation

SetItemBatch(string, string, SetItemBatchBody, CancellationToken)

Set Player Item Batch

Declaration

ApiOperation<SetItemBatchResponse> SetItemBatch(string projectId, string playerId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
SetItemBatchBody	setItemBatchBody	Set batch data items for a player. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemBatchResponse>	The operation

SetPrivateCustomItem(string, string, SetItemBody, CancellationToken)

Set Private Custom Item

Declaration

ApiOperation<SetItemResponse> SetPrivateCustomItem(string projectId, string customId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
SetItemBody	setItemBody	Add a data item to store for a custom ID. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemResponse>	The operation

SetPrivateCustomItemBatch(string, string, SetItemBatchBody, CancellationToken)

Set Private Custom Item Batch

Declaration

ApiOperation<SetItemBatchResponse> SetPrivateCustomItemBatch(string projectId, string customId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	customId	The custom data ID specified by the user. Must be between 1 and 50 characters long and contain only alphanumeric characters, underscores, and hyphens.
SetItemBatchBody	setItemBatchBody	Set batch data items for a custom ID. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemBatchResponse>	The operation

SetProtectedItem(string, string, SetItemBody, CancellationToken)

Set Protected Player Item

Declaration

ApiOperation<SetItemResponse> SetProtectedItem(string projectId, string playerId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
SetItemBody	setItemBody	Add a data item to store for a player. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemResponse>	The operation

SetProtectedItemBatch(string, string, SetItemBatchBody, CancellationToken)

Set Protected Player Item Batch

Declaration

ApiOperation<SetItemBatchResponse> SetProtectedItemBatch(string projectId, string playerId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
SetItemBatchBody	setItemBatchBody	Set batch data items for a player. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemBatchResponse>	The operation

SetPublicItem(string, string, SetItemBody, CancellationToken)

Set Public Player Item

Declaration

ApiOperation<SetItemResponse> SetPublicItem(string projectId, string playerId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
SetItemBody	setItemBody	Add a data item to store for a player. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemResponse>	The operation

SetPublicItemBatch(string, string, SetItemBatchBody, CancellationToken)

Set Public Player Item Batch

Declaration

ApiOperation<SetItemBatchResponse> SetPublicItemBatch(string projectId, string playerId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	The player ID supplied by the Authorization service.
SetItemBatchBody	setItemBatchBody	Set batch data items for a player. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SetItemBatchResponse>	The operation