Class CloudSaveFilesAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

CloudSaveFilesAdminApi

Implements

ICloudSaveFilesAdminApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.CloudSave

Assembly: Unity.Services.Apis.dll

Syntax

public class CloudSaveFilesAdminApi : ICloudSaveFilesAdminApi, IApiAccessor

Constructors

CloudSaveFilesAdminApi(IApiClient)

Initializes a new instance of the CloudSaveFilesAdminApi class using a Configuration object and client instance.

Declaration

public CloudSaveFilesAdminApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

CloudSaveFilesAdminApi(IApiClient, IApiConfiguration)

Initializes a new instance of the CloudSaveFilesAdminApi class using a Configuration object and client instance.

Declaration

public CloudSaveFilesAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	An instance of the Configuration

Methods

DeletePlayerFile(string, string, string, string, string, CancellationToken)

Delete Player File Deletes the specified player file. If a WriteLock is provided, the file will only be deleted if it matches the stored WriteLock.

Declaration

public 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)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetPlayerFileDownloadUrl(string, string, string, string, CancellationToken)

Get Player File Download URL Generates a signed URL that will allow the client to download the requested player file for a limited period of time. If successful, an object will be returned containing all necessary information to perform the download

Declaration

public 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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<FileDetail>	The operation

GetPlayersWithFiles(string, string, string, int?, CancellationToken)

List Players with Files Retrieves a list of all players that have files saved in storage, ordered alphabetically.

Declaration

public 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)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetPlayersWithFilesResponse>	The operation

ListPlayerFiles(string, string, string, string, CancellationToken)

List Player Files Retrieves a list of names of all the files currently saved in storage for a player along with size (in bytes), last date modified and current WriteLock. Ordered alphabetically in page sizes of 20.

Declaration

public 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)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<FileList>	The operation

Implements

ICloudSaveFilesAdminApi

IApiAccessor