ApiDocumentConverting class

Provides API for working with document converting

See https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/documentConvert

Constructors

ApiDocumentConverting({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
createMultipartRequest(String method, Uri uri, [bool authorizeRequest = true]) → UcMultipartRequest
inherited
createRequest(String method, Uri uri, [bool authorizeRequest = true]) → UcRequest
inherited
ensureRightVersion(double expectedVersion, String prefix, {bool? exact}) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
process(Map<String, List<DocumentTransformation>> transformers, {bool? storeMode}) Future<ConvertEntity<DocumentConvertingResultEntity>>
resolveStoreModeParam(bool? storeMode) String
inherited
resolveStreamedResponse(FutureOr<StreamedResponse> streamedResponse) Future
inherited
resolveStreamedResponseStatusCode(FutureOr<StreamedResponse> streamedResponse) Future<Response>
inherited
status(int token) Future<ConvertJobEntity<DocumentConvertingResultEntity>>
statusAsStream(int token, {Duration checkInterval = const Duration(seconds: 5)}) Stream<ConvertJobEntity<DocumentConvertingResultEntity>>
Returns processing job as Stream
inherited
toString() String
A string representation of this object.
inherited
transformToPaths(Map<String, List<DocumentTransformation>> transformers) List<String>

Operators

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