Interface ICloudSaveDataAdminApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Admin.CloudSave
Assembly: Unity.Services.Apis.dll
Syntax
public interface ICloudSaveDataAdminApi : IApiAccessor
Methods
CreateDefaultCustomIndex(string, string, CreateIndexBody, CancellationToken)
Create Default Custom Index
Declaration
ApiOperation<CreateIndexResponse> CreateDefaultCustomIndex(string projectId, string environmentId, CreateIndexBody createIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Create |
createIndexBody | Configuration object for the index to be created. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateDefaultPlayerIndex(string, string, CreateIndexBody, CancellationToken)
Create Default Player Index
Declaration
ApiOperation<CreateIndexResponse> CreateDefaultPlayerIndex(string projectId, string environmentId, CreateIndexBody createIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Create |
createIndexBody | Configuration object for the index to be created. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreatePrivateCustomIndex(string, string, CreateIndexBody, CancellationToken)
Create Private Custom Index
Declaration
ApiOperation<CreateIndexResponse> CreatePrivateCustomIndex(string projectId, string environmentId, CreateIndexBody createIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Create |
createIndexBody | Configuration object for the index to be created. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateProtectedPlayerIndex(string, string, CreateIndexBody, CancellationToken)
Create Protected Player Index
Declaration
ApiOperation<CreateIndexResponse> CreateProtectedPlayerIndex(string projectId, string environmentId, CreateIndexBody createIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Create |
createIndexBody | Configuration object for the index to be created. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreatePublicPlayerIndex(string, string, CreateIndexBody, CancellationToken)
Create Public Player Index
Declaration
ApiOperation<CreateIndexResponse> CreatePublicPlayerIndex(string projectId, string environmentId, CreateIndexBody createIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Create |
createIndexBody | Configuration object for the index to be created. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteCustomItem(string, string, string, string, string, CancellationToken)
Delete Custom Item
Declaration
ApiOperation DeleteCustomItem(string projectId, string environmentId, string customId, string key, string writeLock = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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 | key | Item key. |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteCustomItems(string, string, string, CancellationToken)
Delete Custom Items
Declaration
ApiOperation DeleteCustomItems(string projectId, string environmentId, string customId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteDefaultCustomIndex(string, string, string, CancellationToken)
Delete Default Custom Index
Declaration
ApiOperation DeleteDefaultCustomIndex(string projectId, string environmentId, string indexId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | indexId | The index ID supplied by the Cloud Save service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteDefaultPlayerIndex(string, string, string, CancellationToken)
Delete Default Player Index
Declaration
ApiOperation DeleteDefaultPlayerIndex(string projectId, string environmentId, string indexId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | indexId | The index ID supplied by the Cloud Save service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteItem(string, string, string, string, string, CancellationToken)
Delete Player Item
Declaration
ApiOperation DeleteItem(string projectId, string environmentId, string playerId, string key, string writeLock = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
string | key | Item key. |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteItems(string, string, string, CancellationToken)
Delete Player Items
Declaration
ApiOperation DeleteItems(string projectId, string environmentId, string playerId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeletePrivateCustomIndex(string, string, string, CancellationToken)
Delete Private Custom Index
Declaration
ApiOperation DeletePrivateCustomIndex(string projectId, string environmentId, string indexId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | indexId | The index ID supplied by the Cloud Save service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeletePrivateCustomItem(string, string, string, string, string, CancellationToken)
Delete Private Custom Item
Declaration
ApiOperation DeletePrivateCustomItem(string projectId, string environmentId, string customId, string key, string writeLock = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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 | key | Item key. |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeletePrivateCustomItems(string, string, string, CancellationToken)
Delete Private Custom Items
Declaration
ApiOperation DeletePrivateCustomItems(string projectId, string environmentId, string customId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteProtectedItem(string, string, string, string, string, CancellationToken)
Delete Protected Player Item
Declaration
ApiOperation DeleteProtectedItem(string projectId, string environmentId, string playerId, string key, string writeLock = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
string | key | Item key. |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteProtectedItems(string, string, string, CancellationToken)
Delete Protected Player Items
Declaration
ApiOperation DeleteProtectedItems(string projectId, string environmentId, string playerId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteProtectedPlayerIndex(string, string, string, CancellationToken)
Delete Protected Player Index
Declaration
ApiOperation DeleteProtectedPlayerIndex(string projectId, string environmentId, string indexId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | indexId | The index ID supplied by the Cloud Save service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeletePublicItem(string, string, string, string, string, CancellationToken)
Delete Public Player Item
Declaration
ApiOperation DeletePublicItem(string projectId, string environmentId, string playerId, string key, string writeLock = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
string | key | Item key. |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeletePublicItems(string, string, string, CancellationToken)
Delete Public Player Items
Declaration
ApiOperation DeletePublicItems(string projectId, string environmentId, string playerId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeletePublicPlayerIndex(string, string, string, CancellationToken)
Delete Public Player Index
Declaration
ApiOperation DeletePublicPlayerIndex(string projectId, string environmentId, string indexId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | indexId | The index ID supplied by the Cloud Save service. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetCustomItems(string, string, string, List<string>, string, CancellationToken)
Get Custom Items
Declaration
ApiOperation<GetItemsResponse> GetCustomItems(string projectId, string environmentId, string customId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
string | after | The key after which to retrieve the next page of keys. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetCustomKeys(string, string, string, string, CancellationToken)
Get Custom Keys
Declaration
ApiOperation<GetKeysResponse> GetCustomKeys(string projectId, string environmentId, string customId, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetItems(string, string, string, List<string>, string, CancellationToken)
Get Player Items
Declaration
ApiOperation<GetItemsResponse> GetItems(string projectId, string environmentId, string playerId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
List<string> | keys | The keys to retrieve, in exploded form style, e.g. |
string | after | The key after which to retrieve the next page of keys. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetKeys(string, string, string, string, CancellationToken)
Get Player Keys
Declaration
ApiOperation<GetKeysResponse> GetKeys(string projectId, string environmentId, string playerId, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
string | after | Returns the page of results after the key specified. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetPrivateCustomItems(string, string, string, List<string>, string, CancellationToken)
Get Private Custom Items
Declaration
ApiOperation<GetItemsResponse> GetPrivateCustomItems(string projectId, string environmentId, string customId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
string | after | The key after which to retrieve the next page of keys. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetPrivateCustomKeys(string, string, string, string, CancellationToken)
Get Private Custom Keys
Declaration
ApiOperation<GetKeysResponse> GetPrivateCustomKeys(string projectId, string environmentId, string customId, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetProtectedItems(string, string, string, List<string>, string, CancellationToken)
Get Protected Player Items
Declaration
ApiOperation<GetItemsResponse> GetProtectedItems(string projectId, string environmentId, string playerId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
List<string> | keys | The keys to retrieve, in exploded form style, e.g. |
string | after | The key after which to retrieve the next page of keys. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetProtectedKeys(string, string, string, string, CancellationToken)
Get Protected Player Keys
Declaration
ApiOperation<GetKeysResponse> GetProtectedKeys(string projectId, string environmentId, string playerId, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
string | after | Returns the page of results after the key specified. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetPublicItems(string, string, string, List<string>, string, CancellationToken)
Get Public Player Items
Declaration
ApiOperation<GetItemsResponse> GetPublicItems(string projectId, string environmentId, string playerId, List<string> keys = null, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
List<string> | keys | The keys to retrieve, in exploded form style, e.g. |
string | after | The key after which to retrieve the next page of keys. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetPublicKeys(string, string, string, string, CancellationToken)
Get Public Player Keys
Declaration
ApiOperation<GetKeysResponse> GetPublicKeys(string projectId, string environmentId, string playerId, string after = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
string | after | Returns the page of results after the key specified. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListIndexes(string, string, CancellationToken)
List Indexes
Declaration
ApiOperation<GetIndexIdsResponse> ListIndexes(string projectId, string environmentId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
QueryDefaultCustomData(string, string, QueryIndexBody, CancellationToken)
Query Default Custom Data
Declaration
ApiOperation<QueryIndexResponse> QueryDefaultCustomData(string projectId, string environmentId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Query |
queryIndexBody | Query object with an array of conditions to query the data with. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
QueryDefaultPlayerData(string, string, QueryIndexBody, CancellationToken)
Query Default Player Data
Declaration
ApiOperation<QueryIndexResponse> QueryDefaultPlayerData(string projectId, string environmentId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Query |
queryIndexBody | Query object with an array of conditions to query the data with. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
QueryPrivateCustomData(string, string, QueryIndexBody, CancellationToken)
Query Private Custom Data
Declaration
ApiOperation<QueryIndexResponse> QueryPrivateCustomData(string projectId, string environmentId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Query |
queryIndexBody | Query object with an array of conditions to query the data with. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
QueryProtectedPlayerData(string, string, QueryIndexBody, CancellationToken)
Query Protected Player Data
Declaration
ApiOperation<QueryIndexResponse> QueryProtectedPlayerData(string projectId, string environmentId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Query |
queryIndexBody | Query object with an array of conditions to query the data with. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
QueryPublicPlayerData(string, string, QueryIndexBody, CancellationToken)
Query Public Player Data
Declaration
ApiOperation<QueryIndexResponse> QueryPublicPlayerData(string projectId, string environmentId, QueryIndexBody queryIndexBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Query |
queryIndexBody | Query object with an array of conditions to query the data with. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetCustomItem(string, string, string, SetItemBody, CancellationToken)
Set Custom Item
Declaration
ApiOperation<SetItemResponse> SetCustomItem(string projectId, string environmentId, string customId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
Set |
setItemBody | Add a data item to store for a custom ID. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetCustomItemBatch(string, string, string, SetItemBatchBody, CancellationToken)
Set Custom Item Batch
Declaration
ApiOperation<SetItemBatchResponse> SetCustomItemBatch(string projectId, string environmentId, string customId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
Set |
setItemBatchBody | Set batch data items for a custom ID. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetItem(string, string, string, SetItemBody, CancellationToken)
Set Player Item
Declaration
ApiOperation<SetItemResponse> SetItem(string projectId, string environmentId, string playerId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Set |
setItemBody | Add a data item to store for a player. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetItemBatch(string, string, string, SetItemBatchBody, CancellationToken)
Set Player Item Batch
Declaration
ApiOperation<SetItemBatchResponse> SetItemBatch(string projectId, string environmentId, string playerId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Set |
setItemBatchBody | Set batch data items for a player. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetPrivateCustomItem(string, string, string, SetItemBody, CancellationToken)
Set Private Custom Item
Declaration
ApiOperation<SetItemResponse> SetPrivateCustomItem(string projectId, string environmentId, string customId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
Set |
setItemBody | Add a data item to store for a custom ID. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetPrivateCustomItemBatch(string, string, string, SetItemBatchBody, CancellationToken)
Set Private Custom Item Batch
Declaration
ApiOperation<SetItemBatchResponse> SetPrivateCustomItemBatch(string projectId, string environmentId, string customId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a 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. |
Set |
setItemBatchBody | Set batch data items for a custom ID. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetProtectedItem(string, string, string, SetItemBody, CancellationToken)
Set Protected Player Item
Declaration
ApiOperation<SetItemResponse> SetProtectedItem(string projectId, string environmentId, string playerId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Set |
setItemBody | Add a data item to store for a player. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetProtectedItemBatch(string, string, string, SetItemBatchBody, CancellationToken)
Set Protected Player Item Batch
Declaration
ApiOperation<SetItemBatchResponse> SetProtectedItemBatch(string projectId, string environmentId, string playerId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Set |
setItemBatchBody | Set batch data items for a player. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetPublicItem(string, string, string, SetItemBody, CancellationToken)
Set Public Player Item
Declaration
ApiOperation<SetItemResponse> SetPublicItem(string projectId, string environmentId, string playerId, SetItemBody setItemBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Set |
setItemBody | Add a data item to store for a player. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
SetPublicItemBatch(string, string, string, SetItemBatchBody, CancellationToken)
Set Public Player Item Batch
Declaration
ApiOperation<SetItemBatchResponse> SetPublicItemBatch(string projectId, string environmentId, string playerId, SetItemBatchBody setItemBatchBody = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | playerId | The player ID supplied by the Authorization service. |
Set |
setItemBatchBody | Set batch data items for a player. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |