Interface ICloudSaveFilesApi

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 ICloudSaveFilesApi : IApiAccessor

Methods

DeleteFile(string, string, string, string, CancellationToken)

Delete Player File

Declaration

ApiOperation DeleteFile(string projectId, string playerId, string key, string writeLock = 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	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

GetDownloadUrl(string, string, string, CancellationToken)

Get Player File Download URL

Declaration

ApiOperation<SignedUrlResponse> GetDownloadUrl(string projectId, string playerId, string key, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the 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<SignedUrlResponse>	The operation

GetFileMetadata(string, string, string, CancellationToken)

Get Player File Metadata

Declaration

ApiOperation<FileItem> GetFileMetadata(string projectId, string playerId, string key, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the 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<FileItem>	The operation

GetUploadUrl(string, string, string, FileDetails, CancellationToken)

Get Player File upload URL

Declaration

ApiOperation<SignedUrlResponse> GetUploadUrl(string projectId, string playerId, string key, FileDetails fileDetails = 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	key	Item key.
FileDetails	fileDetails	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SignedUrlResponse>	The operation

ListPlayerFiles(string, string, string, CancellationToken)

List Player Files

Declaration

ApiOperation<FileList> ListPlayerFiles(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	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