Interface IUsenetClient

Namespace

TorBoxSDK.Main.Usenet

Assembly

TorBoxSDK.dll

Defines operations for managing usenet downloads through the TorBox Main API.

public interface IUsenetClient

Methods

AsyncCreateUsenetDownloadAsync(CreateUsenetDownloadRequest, CancellationToken)

Creates a new Usenet download with asynchronous server-side processing.

Task<TorBoxResponse<UsenetDownload>> AsyncCreateUsenetDownloadAsync(CreateUsenetDownloadRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateUsenetDownloadRequest

The Usenet download creation request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<UsenetDownload>>

The created Usenet download details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

CheckCachedAsync(IReadOnlyList<string>, CheckCachedOptions?, CancellationToken)

Checks whether one or more Usenet hashes are cached on TorBox (GET).

Task<TorBoxResponse<CheckUsenetCached>> CheckCachedAsync(IReadOnlyList<string> hashes, CheckCachedOptions? options = null, CancellationToken cancellationToken = default)

Parameters

hashes IReadOnlyList<string>

The list of hashes to check for cache availability.

options CheckCachedOptions

Optional cache check parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<CheckUsenetCached>>

The cache status data.

Exceptions

ArgumentNullException

Thrown when hashes is null.

TorBoxException

Thrown when the API returns an error.

CheckCachedByPostAsync(CheckUsenetCachedRequest, CancellationToken)

Checks whether one or more Usenet hashes are cached on TorBox (POST).

Task<TorBoxResponse<CheckUsenetCached>> CheckCachedByPostAsync(CheckUsenetCachedRequest request, CancellationToken cancellationToken = default)

Parameters

request CheckUsenetCachedRequest

The cache check request containing hashes and options.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<CheckUsenetCached>>

The cache status data.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

ControlUsenetDownloadAsync(ControlUsenetDownloadRequest, CancellationToken)

Performs a control operation on a Usenet download.

Task<TorBoxResponse> ControlUsenetDownloadAsync(ControlUsenetDownloadRequest request, CancellationToken cancellationToken = default)

Parameters

request ControlUsenetDownloadRequest

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.

CreateUsenetDownloadAsync(CreateUsenetDownloadRequest, CancellationToken)

Creates a new Usenet download from a link or NZB file.

Task<TorBoxResponse<UsenetDownload>> CreateUsenetDownloadAsync(CreateUsenetDownloadRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateUsenetDownloadRequest

The Usenet download creation request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<UsenetDownload>>

The created Usenet download details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

EditUsenetDownloadAsync(EditUsenetDownloadRequest, CancellationToken)

Edits the properties of an existing Usenet download.

Task<TorBoxResponse> EditUsenetDownloadAsync(EditUsenetDownloadRequest request, CancellationToken cancellationToken = default)

Parameters

request EditUsenetDownloadRequest

The edit request containing the new property values.

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.

GetMyUsenetListAsync(GetMyListOptions?, CancellationToken)

Retrieves the authenticated user's Usenet download list.

Task<TorBoxResponse<IReadOnlyList<UsenetDownload>>> GetMyUsenetListAsync(GetMyListOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options GetMyListOptions

Optional query parameters for filtering and pagination.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyList<UsenetDownload>>>

A list of Usenet downloads.

Exceptions

TorBoxException

Thrown when the API returns an error.

RequestDownloadAsync(long, RequestUsenetDownloadOptions?, CancellationToken)

Requests a download link for a Usenet download.

Task<TorBoxResponse<string>> RequestDownloadAsync(long usenetId, RequestUsenetDownloadOptions? options = null, CancellationToken cancellationToken = default)

Parameters

usenetId long

The unique identifier of the Usenet download.

options RequestUsenetDownloadOptions

Optional download request options.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<string>>

The download URL as a string.

Exceptions

TorBoxException

Thrown when the API returns an error.