$TaskProcessingApiClient class

Constructors

$TaskProcessingApiClient($Client _rootClient)
Creates a new DynamiteClient for task_processing_api requests.

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

$cancelTask_Request({required int taskId, bool? oCSAPIRequest}) → Request
Cancels a task.
$cancelTask_Serializer() → DynamiteSerializer<TaskProcessingApiCancelTaskResponseApplicationJson, void>
Builds a serializer to parse the response of $cancelTask_Request.
$deleteTask_Request({required int id, bool? oCSAPIRequest}) → Request
Deletes a task.
$deleteTask_Serializer() → DynamiteSerializer<TaskProcessingApiDeleteTaskResponseApplicationJson, void>
Builds a serializer to parse the response of $deleteTask_Request.
$getFileContents_Request({required int taskId, required int fileId, bool? oCSAPIRequest}) → Request
Returns the contents of a file referenced in a task.
$getFileContents_Serializer() → DynamiteSerializer<Uint8List, void>
Builds a serializer to parse the response of $getFileContents_Request.
$getFileContentsExApp_Request({required int taskId, required int fileId, bool? oCSAPIRequest}) → Request
Returns the contents of a file referenced in a task(ExApp route version).
$getFileContentsExApp_Serializer() → DynamiteSerializer<Uint8List, void>
Builds a serializer to parse the response of $getFileContentsExApp_Request.
$getNextScheduledTask_Request({required BuiltList<String> providerIds, required BuiltList<String> taskTypeIds, bool? oCSAPIRequest}) → Request
Returns the next scheduled task for the taskTypeId.
$getNextScheduledTask_Serializer() → DynamiteSerializer<TaskProcessingApiGetNextScheduledTaskResponseApplicationJson, void>
Builds a serializer to parse the response of $getNextScheduledTask_Request.
$getTask_Request({required int id, bool? oCSAPIRequest}) → Request
Gets a task including status and result.
$getTask_Serializer() → DynamiteSerializer<TaskProcessingApiGetTaskResponseApplicationJson, void>
Builds a serializer to parse the response of $getTask_Request.
$listTasks_Request({String? taskType, String? customId, bool? oCSAPIRequest}) → Request
Returns tasks for the current user filtered by the optional taskType and optional customId.
$listTasks_Serializer() → DynamiteSerializer<TaskProcessingApiListTasksResponseApplicationJson, void>
Builds a serializer to parse the response of $listTasks_Request.
$listTasksByApp_Request({required String appId, String? customId, bool? oCSAPIRequest}) → Request
Returns tasks for the current user filtered by the appId and optional customId.
$listTasksByApp_Serializer() → DynamiteSerializer<TaskProcessingApiListTasksByAppResponseApplicationJson, void>
Builds a serializer to parse the response of $listTasksByApp_Request.
$schedule_Request({required TaskProcessingApiScheduleRequestApplicationJson $body, bool? oCSAPIRequest}) → Request
Schedules a task.
$schedule_Serializer() → DynamiteSerializer<TaskProcessingApiScheduleResponseApplicationJson, void>
Builds a serializer to parse the response of $schedule_Request.
$setFileContentsExApp_Request({required int taskId, bool? oCSAPIRequest}) → Request
Upload a file so it can be referenced in a task result (ExApp route version).
$setFileContentsExApp_Serializer() → DynamiteSerializer<TaskProcessingApiSetFileContentsExAppResponseApplicationJson, void>
Builds a serializer to parse the response of $setFileContentsExApp_Request.
$setProgress_Request({required int taskId, required TaskProcessingApiSetProgressRequestApplicationJson $body, bool? oCSAPIRequest}) → Request
Sets the task progress.
$setProgress_Serializer() → DynamiteSerializer<TaskProcessingApiSetProgressResponseApplicationJson, void>
Builds a serializer to parse the response of $setProgress_Request.
$setResult_Request({required int taskId, bool? oCSAPIRequest, TaskProcessingApiSetResultRequestApplicationJson? $body}) → Request
Sets the task result.
$setResult_Serializer() → DynamiteSerializer<TaskProcessingApiSetResultResponseApplicationJson, void>
Builds a serializer to parse the response of $setResult_Request.
$taskTypes_Request({bool? oCSAPIRequest}) → Request
Returns all available TaskProcessing task types.
$taskTypes_Serializer() → DynamiteSerializer<TaskProcessingApiTaskTypesResponseApplicationJson, void>
Builds a serializer to parse the response of $taskTypes_Request.
cancelTask({required int taskId, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiCancelTaskResponseApplicationJson, void>>
Cancels a task.
deleteTask({required int id, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiDeleteTaskResponseApplicationJson, void>>
Deletes a task.
getFileContents({required int taskId, required int fileId, bool? oCSAPIRequest}) Future<DynamiteResponse<Uint8List, void>>
Returns the contents of a file referenced in a task.
getFileContentsExApp({required int taskId, required int fileId, bool? oCSAPIRequest}) Future<DynamiteResponse<Uint8List, void>>
Returns the contents of a file referenced in a task(ExApp route version).
getNextScheduledTask({required BuiltList<String> providerIds, required BuiltList<String> taskTypeIds, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiGetNextScheduledTaskResponseApplicationJson, void>>
Returns the next scheduled task for the taskTypeId.
getTask({required int id, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiGetTaskResponseApplicationJson, void>>
Gets a task including status and result.
listTasks({String? taskType, String? customId, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiListTasksResponseApplicationJson, void>>
Returns tasks for the current user filtered by the optional taskType and optional customId.
listTasksByApp({required String appId, String? customId, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiListTasksByAppResponseApplicationJson, void>>
Returns tasks for the current user filtered by the appId and optional customId.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
schedule({required TaskProcessingApiScheduleRequestApplicationJson $body, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiScheduleResponseApplicationJson, void>>
Schedules a task.
setFileContentsExApp({required int taskId, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiSetFileContentsExAppResponseApplicationJson, void>>
Upload a file so it can be referenced in a task result (ExApp route version).
setProgress({required int taskId, required TaskProcessingApiSetProgressRequestApplicationJson $body, bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiSetProgressResponseApplicationJson, void>>
Sets the task progress.
setResult({required int taskId, bool? oCSAPIRequest, TaskProcessingApiSetResultRequestApplicationJson? $body}) Future<DynamiteResponse<TaskProcessingApiSetResultResponseApplicationJson, void>>
Sets the task result.
taskTypes({bool? oCSAPIRequest}) Future<DynamiteResponse<TaskProcessingApiTaskTypesResponseApplicationJson, void>>
Returns all available TaskProcessing task types.
toString() String
A string representation of this object.
inherited

Operators

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