Interface ICloudSaveFilesAdminApi
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 ICloudSaveFilesAdminApi : IApiAccessor
Methods
DeletePlayerFile(string, string, string, string, string, CancellationToken)
Delete Player File
Declaration
ApiOperation DeletePlayerFile(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 file. 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 |
GetPlayerFileDownloadUrl(string, string, string, string, CancellationToken)
Get Player File Download URL
Declaration
ApiOperation<FileDetail> GetPlayerFileDownloadUrl(string projectId, string environmentId, string playerId, string key, 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. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetPlayersWithFiles(string, string, string, int?, CancellationToken)
List Players with Files
Declaration
ApiOperation<GetPlayersWithFilesResponse> GetPlayersWithFiles(string projectId, string environmentId, string after = null, int? pageSize = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | after | The player after which to retrieve the next page of players. (optional) |
int? | pageSize | The list size of the returned players, defaulted to 20. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListPlayerFiles(string, string, string, string, CancellationToken)
List Player Files
Declaration
ApiOperation<FileList> ListPlayerFiles(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 | The key after which to retrieve the next page of files. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |