Interface IRssClient

Namespace

TorBoxSDK.Main.Rss

Assembly

TorBoxSDK.dll

Defines operations for managing RSS feeds through the TorBox Main API.

public interface IRssClient

Methods

AddRssAsync(AddRssRequest, CancellationToken)

Adds a new RSS feed to the user's account.

Task<TorBoxResponse> AddRssAsync(AddRssRequest request, CancellationToken cancellationToken = default)

Parameters

request AddRssRequest

The RSS feed creation 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.

ControlRssAsync(ControlRssRequest, CancellationToken)

Performs a control operation on an RSS feed.

Task<TorBoxResponse> ControlRssAsync(ControlRssRequest request, CancellationToken cancellationToken = default)

Parameters

request ControlRssRequest

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.

GetFeedItemsAsync(long, CancellationToken)

Retrieves items from a specific RSS feed.

Task<TorBoxResponse<IReadOnlyList<RssFeedItem>>> GetFeedItemsAsync(long rssFeedId, CancellationToken cancellationToken = default)

Parameters

rssFeedId long

The identifier of the RSS feed.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyList<RssFeedItem>>>

A list of RSS feed items.

Exceptions

TorBoxException

Thrown when the API returns an error.

GetFeedsAsync(CancellationToken)

Retrieves the user's configured RSS feeds.

Task<TorBoxResponse<IReadOnlyList<RssFeed>>> GetFeedsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyList<RssFeed>>>

A list of RSS feeds.

Exceptions

TorBoxException

Thrown when the API returns an error.

ModifyRssAsync(ModifyRssRequest, CancellationToken)

Modifies the properties of an existing RSS feed.

Task<TorBoxResponse> ModifyRssAsync(ModifyRssRequest request, CancellationToken cancellationToken = default)

Parameters

request ModifyRssRequest

The modification 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.