Interface ITasksClient

interface ITasksClient {
    cancelTasks(
        args: { repositoryId: string; taskIds?: null | string[] },
    ): Promise<CancelTasksResponse>;
    listTasks(
        args: { repositoryId: string; taskIds?: null | string[] },
    ): Promise<TaskCollectionResponse>;
}

Implemented by

Methods

cancelTasks listTasks

Methods

cancelTasks

  • cancelTasks(
        args: { repositoryId: string; taskIds?: null | string[] },
    ): Promise<CancelTasksResponse>
    • Starts the cancellation for a set of one or more tasks.
    • Provide comma-separated list of task IDs to cancel. Should be used if an operation was created in error, or is no longer necessary.
    • Check the status of the task to determine if the task has been cancelled successfully.
    • Leave the taskIds query parameter empty, to cancel the list of all the task IDs associated with the current access token.
    • Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.
    • Required OAuth scope: None

    Parameters

    • args: { repositoryId: string; taskIds?: null | string[] }
      • repositoryId: string

        The requested repository ID

      • OptionaltaskIds?: null | string[]

        (optional) An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token.

    Returns Promise<CancelTasksResponse>

    A collection of task cancellation results.

listTasks

  • listTasks(
        args: { repositoryId: string; taskIds?: null | string[] },
    ): Promise<TaskCollectionResponse>
    • Returns the status of a set of one or more tasks.
    • Provide a comma-separated list of task IDs to get the task status, progress, and any errors that may have occurred.
    • Leave the taskIds query parameter empty, to get the list of all the task IDs associated with the current access token.
    • TaskStatus can be one of the following values: NotStarted, InProgress, Completed, Cancelled, or Failed.
    • This API employs long polling technique and could return the result immediately (e.g. if the export operation is failed or completed successfully) or after at most 60 seconds.
    • Required OAuth scope: None

    Parameters

    • args: { repositoryId: string; taskIds?: null | string[] }
      • repositoryId: string

        The requested repository ID

      • OptionaltaskIds?: null | string[]

        (optional) An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token.

    Returns Promise<TaskCollectionResponse>

    A collection of task progresses.

Settings

Member Visibility

On This Page

Methods