ApiAddons class
Since v0.7
An Add-On is an application implemented by Uploadcare that accepts uploaded
files as an input and can produce other files and/or appdata as an output.
See https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons
Constructors
- ApiAddons({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
-
checkAWSRekognitionExecutionStatus(
String requestId) → Future< AddonExecutionStatus< void> > - Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-
checkClamAVExecutionStatus(
String requestId) → Future< AddonExecutionStatus< void> > - Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-
checkRemoveBgExecutionStatus(
String requestId) → Future< AddonExecutionStatus< String> > - Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-
checkTaskExecutionStatusAsStream<
T> ({required String requestId, required Future< AddonExecutionStatus< task(String requestId), Duration checkInterval = const Duration(seconds: 5)}) → Stream<T> >AddonExecutionStatus< T> > -
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
-
executeAWSRekognition(
String fileId) → Future< String> - Execute AWS Rekognition Add-On for a given target to detect labels in an image. Note: Detected labels are stored in the file's appdata.
-
executeClamAV(
String fileId, {bool? purgeInfected}) → Future< String> - Execute ClamAV virus checking Add-On for a given target.
-
executeRemoveBg(
String fileId, {bool? crop, String? cropMargin, String? scale, bool? addShadow, RemoveBgTypeLevelValue? typeLevel, RemoveBgTypeValue? type, bool? semitransparency, RemoveBgChannelsValue? channels, String? roi, String? position}) → Future< String> - Execute remove.bg background image removal Add-On for a given target.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resolveStoreModeParam(
bool? storeMode) → String -
inherited
-
resolveStreamedResponse(
FutureOr< StreamedResponse> streamedResponse) → Future -
inherited
-
resolveStreamedResponseStatusCode(
FutureOr< StreamedResponse> streamedResponse) → Future<Response> -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited