ApiFiles class
Provides API for working with files
Constructors
- ApiFiles({required ClientOptions options})
Properties
- apiUrl → String
-
no setterinherited
- cdnUrl → String
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- options → ClientOptions
-
final
- privateKey → String?
-
no setterinherited
- publicKey → String
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uploadUrl → String
-
no setterinherited
- useAgent → String
-
no setterinherited
Methods
-
buildUri(
String url, [Map< String, dynamic> params = const {}]) → Uri -
inherited
-
copyToLocalStorage(
String fileId, {bool? store, Map< String, String> ? metadata}) → Future<FileInfoEntity> - Since v0.6
-
copyToRemoteStorage(
{required String fileId, required String target, bool? makePublic, FilesPatternValue? pattern}) → Future< String> - Since: v0.6
-
createMultipartRequest(
String method, Uri uri, [bool authorizeRequest = true]) → UcMultipartRequest -
inherited
-
createRequest(
String method, Uri uri, [bool authorizeRequest = true]) → UcRequest -
inherited
-
deleteFileMetadataValue(
String fileId, String metadataKey) → Future< void> - Since v0.7 Delete a file's metadata key
-
ensureRightVersion(
double expectedVersion, String prefix, {bool? exact}) → void -
inherited
-
file(
String fileId, {FilesIncludeFields? include, bool includeRecognitionInfo = false}) → Future< FileInfoEntity> -
Retreive file by
fileId
-
getApplicationData(
String fileId) → Future< Map< String, dynamic> > - Since v0.7
-
getApplicationDataByAppName(
String fileId, String appName) → Future< Map< String, dynamic> > - Since v0.7
-
getFacesEntity(
String imageId) → Future< FacesEntity> -
Returns
FacesEntity
which contains original image size and rectangles of faces -
getFileMetadata(
String fileId) → Future< Map< String, String> > - Since v0.7 Get file's metadata keys and values
-
getFileMetadataValue(
String fileId, String metadataKey) → Future< String> - Since v0.7 Get the value of a single metadata key
-
list(
{bool stored = true, bool removed = false, int limit = 100, int? offset, FilesOrdering ordering = const FilesOrdering(FilesFilterValue.DatetimeUploaded), dynamic fromFilter, FilesIncludeFields? include, bool includeRecognitionInfo = false}) → Future< ListEntity< FileInfoEntity> > - Retrieve files
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
remove(
List< String> fileIds) → Future<void> - Batch file delete
-
resolveStoreModeParam(
bool? storeMode) → String -
inherited
-
resolveStreamedResponse(
FutureOr< StreamedResponse> streamedResponse) → Future -
inherited
-
resolveStreamedResponseStatusCode(
FutureOr< StreamedResponse> streamedResponse) → Future<Response> -
inherited
-
store(
List< String> fileIds) → Future<void> -
Store files by
fileIds
-
toString(
) → String -
A string representation of this object.
inherited
-
updateFileMetadataValue(
String fileId, String metadataKey, String value) → Future< String> - Since v0.7 Update the value of a single metadata key. If the key does not exist, it will be created
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited