deleteTask: Delete Task

View source: R/deleteTask.R

deleteTaskR Documentation

Delete Task

Description

Deletes task and associated data. While Abbyy says, "If you try to delete the task that has already been deleted, the successful response is returned," it doesn't appear to hold. Hence, the function now defaults to checking the status of the task via getTaskStatus, and deletes only if it hasn't been deleted.

The function by default prints the status of the task you are trying to delete. It will show up as 'deleted' if successful.

Usage

deleteTask(taskId = NULL, ...)

Arguments

taskId

Required; ID of the task; String

...

Additional arguments passed to abbyy_GET.

Value

Data frame with all the details of the task you are trying to delete: id (task id), registrationTime, statusChangeTime, status (Submitted, Queued, InProgress, Completed, ProcessingFailed, Deleted, NotEnoughCredits), filesCount (No. of files), credits, resultUrl (URL for the processed file if applicable)

References

http://ocrsdk.com/documentation/apireference/deleteTask/

Examples

## Not run: 
deleteTask(taskId = "task_id")

## End(Not run)

soodoku/abbyyR documentation built on July 19, 2023, 8:36 a.m.