FilesApi class

Constructors

FilesApi(Dio _dio)
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createFile({CreateFileRequest? createFileRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<File>>
Create File Creates a new File object
createFileVersion({required String fileId, CreateFileVersionRequest? createFileVersionRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<File>>
Create File Version Creates a new FileVersion. Once a Version has been created, proceed to the `/file/{fileId}/{versionId}/file/start` endpoint to start a file upload.
deleteFile({required String fileId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Success>>
Delete File Deletes a File object.
deleteFileVersion({required String fileId, required int versionId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<File>>
Delete File Version Delete a specific version of a file. You can only delete the latest version.
downloadFileVersion({required String fileId, required int versionId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Download File Version Downloads the file with the provided version number. Version Note: Version 0 is always when the file was created. The real data is usually always located in version 1 and up. Extension Note: Files are not guaranteed to have a file extensions. UnityPackage files tends to have it, images through this endpoint do not. You are responsible for appending file extension from the `extension` field when neccesary.
finishFileDataUpload({required String fileId, required int versionId, required String fileType, FinishFileDataUploadRequest? finishFileDataUploadRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<File>>
Finish FileData Upload Finish an upload of a FileData. This will mark it as &quot;complete&quot;. After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file.
getFile({required String fileId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<File>>
Show File Shows general information about the &quot;File&quot; object. Each File can have several &quot;Version&quot;'s, and each Version can have multiple real files or &quot;Data&quot; blobs.
getFileDataUploadStatus({required String fileId, required int versionId, required String fileType, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<FileVersionUploadStatus>>
Check FileData Upload Status Retrieves the upload status for file upload. Can currently only be accessed when `status` is `waiting`. Trying to access it on a file version already uploaded currently times out.
getFiles({String? tag, String? userId, int? n = 60, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<File>>>
List Files Returns a list of files
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startFileDataUpload({required String fileId, required int versionId, required String fileType, int? partNumber, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<FileUploadURL>>
Start FileData Upload Starts an upload of a specific FilePart. This endpoint will return an AWS URL which you can PUT data to. You need to call this and receive a new AWS API URL for each `partNumber`. Please see AWS's REST documentation on &quot;PUT Object to S3&quot; on how to upload. Once all parts has been uploaded, proceed to `/finish` endpoint. Note: `nextPartNumber` seems like it is always ignored. Despite it returning 0, first partNumber is always 1.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited