FilesApi
Import
Import
Constructors
Constructor
-
Parameters
-
Optional configuration: Configuration
-
basePath: string = ...
-
axios: AxiosInstance = ...
Returns FilesApi
-
Methods
Delete File
-
Parameters
-
projectId: string
ID of the project.
-
playerId: string
The player ID supplied by the Authorization service.
-
key: string
Item key.
-
Optional writeLock: string
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>
-
Get 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.
Parameters
-
projectId: string
ID of the project.
-
playerId: string
The player ID supplied by the Authorization service.
-
key: string
Item key.
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<SignedUrlResponse, any>>
-
Get File Metadata
-
Retrieves the metadata (size, date last modified and created, key, content type, and current WriteLock) of a single player file.
Parameters
-
projectId: string
ID of the project.
-
playerId: string
The player ID supplied by the Authorization service.
-
key: string
Item key.
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<FileItem, any>>
-
Get Upload Url
-
Initiates the player file upload process and returns a URL to which the actual file contents can be uploaded. The type, length and MD5 hash of the file have to be provided up-front. If successful, an object will be returned containing all necessary information to perform the upload.
Parameters
-
projectId: string
ID of the project.
-
playerId: string
The player ID supplied by the Authorization service.
-
key: string
Item key.
-
Optional fileDetails: FileDetails
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<SignedUrlResponse, any>>
-
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.
Parameters
-
projectId: string
ID of the project.
-
playerId: string
The player ID supplied by the Authorization service.
-
Optional after: string
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<FileList, any>>
-
Deletes the specified player file. If a WriteLock is provided, the file will only be deleted if it matches the stored WriteLock.
Delete Player File
{RequiredError}
FilesApi