Interface IQueuedClient

Namespace

TorBoxSDK.Main.Queued

Assembly

TorBoxSDK.dll

Defines operations for managing queued items through the TorBox Main API.

public interface IQueuedClient

Methods

ControlQueuedAsync(ControlQueuedRequest, CancellationToken)

Performs a control operation on queued downloads.

Task<TorBoxResponse> ControlQueuedAsync(ControlQueuedRequest request, CancellationToken cancellationToken = default)

Parameters

request ControlQueuedRequest

The control operation request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse>

The API response.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

GetQueuedAsync(GetQueuedOptions?, CancellationToken)

Retrieves the authenticated user's queued downloads.

Task<TorBoxResponse<IReadOnlyList<QueuedDownload>>> GetQueuedAsync(GetQueuedOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options GetQueuedOptions

Optional query parameters for filtering and pagination.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyList<QueuedDownload>>>

A list of queued downloads.

Exceptions

TorBoxException

Thrown when the API returns an error.