qbittorrent-client/qbittorrent/QBittorrentClient

QBittorrentClient

class QBittorrentClient(baseUrl: String, username: String = "admin", password: String = "adminadmin", syncInterval: Duration = 5.seconds, httpClient: HttpClient = HttpClient(), dispatcher: CoroutineDispatcher = Default)

qBittorrent Web API wrapper.

https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)

Parameters

baseUrl

The base URL of qBittorrent, ex. http://localhost:8080

username

The qBittorrent username, default: admin

password

The qBittorrent password, default: adminadmin

syncInterval

The sync endpoint polling rate when subscribed to a Flow, defaults to 5 seconds.

httpClient

Custom HTTPClient, useful when a default client engine is not used

dispatcher

Coroutine dispatcher for flow API processing, defaults to Dispatchers.Default.

Constructors

QBittorrentClient

constructor(baseUrl: String, username: String = "admin", password: String = "adminadmin", syncInterval: Duration = 5.seconds, httpClient: HttpClient = HttpClient(), dispatcher: CoroutineDispatcher = Default)

Types

Companion

object Companion

Properties

isSyncing

val isSyncing: Boolean

Returns true when observeMainData or observeTorrent have at least one subscriber, meaning the syncing endpoint is being polled at syncInterval.

Functions

addPeers

suspend fun addPeers(hashes: List<String>, peers: List<String>)

addTorrent

suspend fun addTorrent(configure: AddTorrentBody.() -> Unit)

Add torrents from server local file or from URLs. http://, https://, magnet: and bc://bt/ links are supported.

addTorrentTags

suspend fun addTorrentTags(hashes: List<String> = allList, tags: List<String>)

addTrackers

suspend fun addTrackers(hash: String, urls: List<String>)

banPeers

suspend fun banPeers(peers: List<String>)

createCategory

suspend fun createCategory(name: String, savePath: String)

createTags

suspend fun createTags(tags: List<String>)

decreasePriority

suspend fun decreasePriority(hashes: List<String> = allList)

deleteTags

suspend fun deleteTags(tags: List<String>)

deleteTorrents

suspend fun deleteTorrents(hashes: List<String>, deleteFiles: Boolean = false)

Delete one or more torrents.

editCategory

suspend fun editCategory(name: String, savePath: String)

editTrackers

suspend fun editTrackers(hash: String, originalUrl: String, newUrl: String)

getApiVersion

suspend fun getApiVersion(): String

Get the Web API version.

getBuildInfo

suspend fun getBuildInfo(): BuildInfo

Get the build info

getCategories

suspend fun getCategories(): List<Category>

getDefaultSavePath

suspend fun getDefaultSavePath(): String

Get the default torrent save path, ex. /user/home/downloads

getGlobalDownloadLimit

suspend fun getGlobalDownloadLimit(): Int

The response is the value of current global download speed limit in bytes/second; this value will be zero if no limit is applied.

getGlobalTransferInfo

suspend fun getGlobalTransferInfo(): GlobalTransferInfo

getGlobalUploadLimit

suspend fun getGlobalUploadLimit(): Int

The response is the value of current global upload speed limit in bytes/second; this value will be zero if no limit is applied.

getLogs

suspend fun getLogs(normal: Boolean = true, info: Boolean = true, warning: Boolean = true, critical: Boolean = true, lastKnownId: Int = -1): List<LogEntry>

getPeerLogs

suspend fun getPeerLogs(lastKnownId: Int = -1): List<PeerLog>

getPieceHashes

suspend fun getPieceHashes(hash: String): List<String>

Get piece hashes for the torrent at hash.

getPieceStates

suspend fun getPieceStates(hash: String): List<PieceState>

Get piece states for the torrent at hash.

getPreferences

suspend fun getPreferences(): QBittorrentPrefs

Get the qBittorrent application preferences.

getSpeedLimitsMode

suspend fun getSpeedLimitsMode(): Int

The response is 1 if alternative speed limits are enabled, 0 otherwise.

getTags

suspend fun getTags(): List<String>

getTorrentDownloadLimit

suspend fun getTorrentDownloadLimit(hashes: List<String> = allList): Map<String, Long>

getTorrentFiles

suspend fun getTorrentFiles(hash: String, indexes: List<Int> = emptyList()): List<TorrentFile>

Get the TorrentFiles for hash or an empty list if not yet not available.

getTorrentProperties

suspend fun getTorrentProperties(hash: String): TorrentProperties

getTorrents

suspend fun getTorrents(filter: TorrentFilter = TorrentFilter.ALL, category: String? = null, sort: String = "", reverse: Boolean = false, limit: Int = 0, offset: Int = 0, tag: String? = null, hashes: List<String> = emptyList()): List<Torrent>

getTorrentUploadLimit