Interface IQBittorrentClient
Provides access to qBittorrent remote API.
Namespace: QBittorrent.Client
Assembly: QBittorrent.Client.dll
Syntax
public interface IQBittorrentClient
Properties
| Improve this Doc View SourceDefaultRequestHeaders
Gets the headers which should be sent with each request.
Declaration
HttpRequestHeaders DefaultRequestHeaders { get; }
Property Value
| Type | Description |
|---|---|
| System.Net.Http.Headers.HttpRequestHeaders |
Timeout
Gets or sets the timespan to wait before the request times out.
Declaration
TimeSpan Timeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.TimeSpan |
Methods
| Improve this Doc View SourceAddCategoryAsync(String, CancellationToken)
Adds the category.
Declaration
Task AddCategoryAsync(string category, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | category | The category name. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
AddTorrentsAsync(AddTorrentFilesRequest, CancellationToken)
Adds the torrent files to download.
Declaration
Task AddTorrentsAsync(AddTorrentFilesRequest request, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| AddTorrentFilesRequest | request | The request. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
AddTorrentsAsync(AddTorrentUrlsRequest, CancellationToken)
Adds the torrent URLs or magnet-links to download.
Declaration
Task AddTorrentsAsync(AddTorrentUrlsRequest request, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| AddTorrentUrlsRequest | request | The request. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
AddTrackersAsync(String, IEnumerable<Uri>, CancellationToken)
Adds the trackers to the torrent.
Declaration
Task AddTrackersAsync(string hash, IEnumerable<Uri> trackers, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Collections.Generic.IEnumerable<System.Uri> | trackers | The trackers. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ChangeTorrentPriorityAsync(IEnumerable<String>, TorrentPriorityChange, CancellationToken)
Changes the torrent priority.
Declaration
Task ChangeTorrentPriorityAsync(IEnumerable<string> hashes, TorrentPriorityChange change, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| TorrentPriorityChange | change | The priority change. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
DeleteAsync(IEnumerable<String>, Boolean, CancellationToken)
Deletes the torrents.
Declaration
Task DeleteAsync(IEnumerable<string> hashes, bool deleteDownloadedData = false, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Boolean | deleteDownloadedData | true to delete the downloaded data. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
DeleteCategoriesAsync(IEnumerable<String>, CancellationToken)
Deletes the categories.
Declaration
Task DeleteCategoriesAsync(IEnumerable<string> categories, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | categories | The list of categories' names. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
GetAlternativeSpeedLimitsEnabledAsync(CancellationToken)
Gets the value indicating whether the alternative speed limits are enabled.
Declaration
Task<bool> GetAlternativeSpeedLimitsEnabledAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
GetApiVersionAsync(CancellationToken)
Gets the current API version of the server.
Declaration
Task<ApiVersion> GetApiVersionAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiVersion> |
Remarks
For qBittorrent versions before 4.1.0 this method returns version 1.x
where x is the value returned by GetLegacyApiVersionAsync(CancellationToken) method.
For qBittorrent version starting from 4.1.0 this method returns version x.y or x.y.z
where x >= 2.
GetDefaultSavePathAsync(CancellationToken)
Get the path to the folder where the downloaded files are saved by default.
Declaration
Task<string> GetDefaultSavePathAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> |
GetGlobalDownloadLimitAsync(CancellationToken)
Gets the global download speed limit.
Declaration
Task<long?> GetGlobalDownloadLimitAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Nullable<System.Int64>> |
GetGlobalTransferInfoAsync(CancellationToken)
Gets the global transfer information.
Declaration
Task<GlobalTransferInfo> GetGlobalTransferInfoAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GlobalTransferInfo> |
GetGlobalUploadLimitAsync(CancellationToken)
Gets the global upload speed limit.
Declaration
Task<long?> GetGlobalUploadLimitAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Nullable<System.Int64>> |
GetLegacyApiVersionAsync(CancellationToken)
Gets the current API version of the server for qBittorrent versions up to 4.0.4.
Declaration
Task<int> GetLegacyApiVersionAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> |
GetLegacyMinApiVersionAsync(CancellationToken)
Get the minimum API version supported by server. Any application designed to work with an API version greater than or equal to the minimum API version is guaranteed to work.
Declaration
Task<int> GetLegacyMinApiVersionAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> |
GetLogAsync(TorrentLogSeverity, Int32, CancellationToken)
Gets the server log.
Declaration
Task<IEnumerable<TorrentLogEntry>> GetLogAsync(TorrentLogSeverity severity = TorrentLogSeverity.All, int afterId = -1, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| TorrentLogSeverity | severity | The severity of log entries to return. All by default. |
| System.Int32 | afterId | Return the entries with the ID greater than the specified one. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<TorrentLogEntry>> |
GetPartialDataAsync(Int32, CancellationToken)
Gets the partial data.
Declaration
Task<PartialData> GetPartialDataAsync(int responseId = 0, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | responseId | The response identifier. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PartialData> |
GetPeerPartialDataAsync(String, Int32, CancellationToken)
Gets the peer partial data.
Declaration
Task<PeerPartialData> GetPeerPartialDataAsync(string hash, int responseId = 0, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Int32 | responseId | The response identifier. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PeerPartialData> |
GetPreferencesAsync(CancellationToken)
Gets qBittorrent preferences.
Declaration
Task<Preferences> GetPreferencesAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Preferences> |
GetQBittorrentVersionAsync(CancellationToken)
Gets the qBittorrent version.
Declaration
Task<Version> GetQBittorrentVersionAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Version> |
GetTorrentContentsAsync(String, CancellationToken)
Gets the torrent contents.
Declaration
Task<IReadOnlyList<TorrentContent>> GetTorrentContentsAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<TorrentContent>> |
GetTorrentDownloadLimitAsync(IEnumerable<String>, CancellationToken)
Gets the torrent download speed limit.
Declaration
Task<IReadOnlyDictionary<string, long?>> GetTorrentDownloadLimitAsync(IEnumerable<string> hashes, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<System.String, System.Nullable<System.Int64>>> |
GetTorrentListAsync(TorrentListQuery, CancellationToken)
Gets the torrent list.
Declaration
Task<IReadOnlyList<TorrentInfo>> GetTorrentListAsync(TorrentListQuery query = null, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| TorrentListQuery | query | The query. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<TorrentInfo>> |
GetTorrentPiecesHashesAsync(String, CancellationToken)
Gets the hashes of the torrent pieces.
Declaration
Task<IReadOnlyList<string>> GetTorrentPiecesHashesAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>> |
GetTorrentPiecesStatesAsync(String, CancellationToken)
Gets the states of the torrent pieces.
Declaration
Task<IReadOnlyList<TorrentPieceState>> GetTorrentPiecesStatesAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<TorrentPieceState>> |
GetTorrentPropertiesAsync(String, CancellationToken)
Gets the torrent generic properties.
Declaration
Task<TorrentProperties> GetTorrentPropertiesAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TorrentProperties> |
GetTorrentTrackersAsync(String, CancellationToken)
Gets the torrent trackers.
Declaration
Task<IReadOnlyList<TorrentTracker>> GetTorrentTrackersAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<TorrentTracker>> |
GetTorrentUploadLimitAsync(IEnumerable<String>, CancellationToken)
Gets the torrent upload speed limit.
Declaration
Task<IReadOnlyDictionary<string, long?>> GetTorrentUploadLimitAsync(IEnumerable<string> hashes, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<System.String, System.Nullable<System.Int64>>> |
GetTorrentWebSeedsAsync(String, CancellationToken)
Gets the torrent web seeds.
Declaration
Task<IReadOnlyList<Uri>> GetTorrentWebSeedsAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.Uri>> |
LoginAsync(String, String, CancellationToken)
Authenticates this client with the remote qBittorrent server.
Declaration
Task LoginAsync(string username, string password, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | The username. |
| System.String | password | The password. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
LogoutAsync(CancellationToken)
Clears authentication on the remote qBittorrent server.
Declaration
Task LogoutAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
PauseAllAsync(CancellationToken)
Pauses all torrents.
Declaration
Task PauseAllAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
PauseAsync(String, CancellationToken)
Pauses the torrent.
Declaration
Task PauseAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
RecheckAsync(String, CancellationToken)
Rechecks the torrent.
Declaration
Task RecheckAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
RenameAsync(String, String, CancellationToken)
Renames the torrent.
Declaration
Task RenameAsync(string hash, string newName, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.String | newName | The new name. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ResumeAllAsync(CancellationToken)
Resumes all torrents.
Declaration
Task ResumeAllAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ResumeAsync(String, CancellationToken)
Resumes the torrent.
Declaration
Task ResumeAsync(string hash, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetAutomaticTorrentManagementAsync(IEnumerable<String>, Boolean, CancellationToken)
Sets the automatic torrent management.
Declaration
Task SetAutomaticTorrentManagementAsync(IEnumerable<string> hashes, bool enabled, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Boolean | enabled | |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetFilePriorityAsync(String, Int32, TorrentContentPriority, CancellationToken)
Sets the file priority.
Declaration
Task SetFilePriorityAsync(string hash, int fileId, TorrentContentPriority priority, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hash | The torrent hash. |
| System.Int32 | fileId | The file identifier. |
| TorrentContentPriority | priority | The priority. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetForceStartAsync(IEnumerable<String>, Boolean, CancellationToken)
Sets the force start.
Declaration
Task SetForceStartAsync(IEnumerable<string> hashes, bool enabled, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Boolean | enabled | |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetGlobalDownloadLimitAsync(Int64, CancellationToken)
Sets the global download speed limit.
Declaration
Task SetGlobalDownloadLimitAsync(long limit, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | limit | The limit. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetGlobalUploadLimitAsync(Int64, CancellationToken)
Sets the global upload speed limit.
Declaration
Task SetGlobalUploadLimitAsync(long limit, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | limit | The limit. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetLocationAsync(IEnumerable<String>, String, CancellationToken)
Sets the location of the torrents.
Declaration
Task SetLocationAsync(IEnumerable<string> hashes, string newLocation, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.String | newLocation | The new location. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetPreferencesAsync(Preferences, CancellationToken)
Gets qBittorrent preferences.
Declaration
Task SetPreferencesAsync(Preferences preferences, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| Preferences | preferences | The prefences to set. You can set only the properties you want to change and leave the other ones as null. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetSuperSeedingAsync(IEnumerable<String>, Boolean, CancellationToken)
Sets the super seeding.
Declaration
Task SetSuperSeedingAsync(IEnumerable<string> hashes, bool enabled, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Boolean | enabled | |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetTorrentCategoryAsync(IEnumerable<String>, String, CancellationToken)
Sets the torrent category.
Declaration
Task SetTorrentCategoryAsync(IEnumerable<string> hashes, string category, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.String | category | The category. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetTorrentDownloadLimitAsync(IEnumerable<String>, Int64, CancellationToken)
Sets the torrent download speed limit.
Declaration
Task SetTorrentDownloadLimitAsync(IEnumerable<string> hashes, long limit, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Int64 | limit | The limit. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetTorrentUploadLimitAsync(IEnumerable<String>, Int64, CancellationToken)
Sets the torrent upload speed limit.
Declaration
Task SetTorrentUploadLimitAsync(IEnumerable<string> hashes, long limit, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Int64 | limit | The limit. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ShutdownApplicationAsync(CancellationToken)
Quits qBittorrent.
Declaration
Task ShutdownApplicationAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ToggleAlternativeSpeedLimitsAsync(CancellationToken)
Toggles the alternative speed limits.
Declaration
Task ToggleAlternativeSpeedLimitsAsync(CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ToggleFirstLastPiecePrioritizedAsync(IEnumerable<String>, CancellationToken)
Toggles the first and last piece priority.
Declaration
Task ToggleFirstLastPiecePrioritizedAsync(IEnumerable<string> hashes, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ToggleSequentialDownloadAsync(IEnumerable<String>, CancellationToken)
Toggles the sequential download.
Declaration
Task ToggleSequentialDownloadAsync(IEnumerable<string> hashes, CancellationToken token = default(CancellationToken))
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | hashes | The torrent hashes. |
| System.Threading.CancellationToken | token | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |