ApiFiles class

Provides API for working with files

Constructors

ApiFiles({required ClientOptions options})

Properties

apiUrl → String

no setter, inherited

cdnUrl → String

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

options → ClientOptions

final

privateKey → String?

no setter, inherited

publicKey → String

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

uploadUrl → String

no setter, inherited

Methods

buildUri(String url, [Map<String, dynamic> params = const {}]) → Uri

inherited

createMultipartRequest(String method, Uri uri, [bool authorizeRequest = true]) → UcMultipartRequest

inherited

createRequest(String method, Uri uri, [bool authorizeRequest = true]) → UcRequest

inherited

file(String fileId, {bool includeRecognitionInfo = false}) → Future<FileInfoEntity>

Retrieve file by fileId

getFacesEntity(String imageId) → Future<FacesEntity>

Returns FacesEntity which contains original image size and rectangles of faces

list({bool stored = true, bool removed = false, int limit = 100, int? offset, FilesOrdering ordering = const FilesOrdering(FilesFilterValue.DatetimeUploaded), dynamic fromFilter, 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<Map<String, dynamic>>

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited