Package-level declarations

Types

class AddTorrentBody(val urls: MutableList<String> = mutableListOf(), val torrents: MutableList<String> = mutableListOf(), val rawTorrents: MutableMap<String, ByteArray> = mutableMapOf(), var savepath: String? = null, var cookie: String? = null, var category: String? = null, val tags: MutableList<String> = mutableListOf(), var skipChecking: Boolean? = null, var paused: Boolean? = null, var rootFolder: Boolean? = null, var rename: String? = null, var upLimit: Long? = null, var dlLimit: Long? = null, var ratioLimit: Float? = null, var seedingTimeLimit: Duration? = null, var autoTMM: Boolean? = null, var sequentialDownload: Boolean? = null, var firstLastPiecePriority: Boolean? = null)

BuildInfo

@Serializable

class BuildInfo(val qt: String, val libtorrent: String, val boost: String, val openssl: String, val bitness: Int)

Category

@Serializable

class Category(val name: String, val savePath: String)

ConnectionStatus

@Serializable

enum ConnectionStatus : Enum<ConnectionStatus>

GlobalTransferInfo

@Serializable

class GlobalTransferInfo(val dlInfoSpeed: Long, val dlInfoData: Long, val upInfoSpeed: Long, val upInfoData: Long, val dlRateLimit: Long, val upRateLimit: Long, val dhtNodes: Int, val connectionStatus: ConnectionStatus, val queueing: Boolean = false, val useAltSpeedLimits: Boolean = false, val refreshInterval: Long = -1)

LogEntry

@Serializable

class LogEntry(val id: Int, val message: String, val timestamp: Long, val type: Int)

MainData

@Serializable

class MainData(val rid: Long, val fullUpdate: Boolean = false, val torrents: Map<String, Torrent> = emptyMap(), val torrentsRemoved: List<String> = emptyList(), val categories: Map<String, Category> = emptyMap(), val categoriesRemoved: List<String> = emptyList(), val tags: List<String> = emptyList(), val tagsRemoved: List<String> = emptyList(), val serverState: ServerState)

PeerLog

@Serializable

class PeerLog(val id: Int, val ip: String, val timestamp: Long, val blocked: Boolean, val reason: String)

PieceState

enum PieceState : Enum<PieceState>

QBittorrentPrefs

@Serializable

class QBittorrentPrefs(val locale: String, val createSubfolderEnabled: Boolean? = null, val startPausedEnabled: Boolean? = null, val autoDeleteMode: Int, val preallocateAll: Boolean, val incompleteFilesExt: Boolean, val autoTmmEnabled: Boolean, val torrentChangedTmmEnabled: Boolean, val savePathChangedTmmEnabled: Boolean, val categoryChangedTmmEnabled: Boolean, val savePath: String, val tempPathEnabled: Boolean, val tempPath: String, val scanDirs: List<ScanDir>, val exportDir: String, val exportDirFinished: String, val mailNotificationEnabled: Boolean, val mailNotificationSender: String, val mailNotificationEmail: String, val mailNotificationSmtp: String, val mailNotificationSslEnabled: Boolean, val mailNotificationAuthEnabled: Boolean, val mailNotificationUsername: String, val mailNotificationPassword: String, val autorunEnabled: Boolean, val autorunProgram: String, val queueingEnabled: Boolean, val maxActiveDownloads: Int, val maxActiveTorrents: Int, val maxActiveUploads: Int, val dontCountSlowTorrents: Boolean, val slowTorrentDlRateThreshold: Int, val slowTorrentUlRateThreshold: Int, val slowTorrentInactiveTimer: Int, val maxRatioEnabled: Boolean, val maxRatio: Float, val maxRatioAction: MaxRatioAction, val listenPort: Int, val upnp: Boolean, val randomPort: Boolean, val dlLimit: Int, val upLimit: Int, val maxConnections: Int, val maxConnectionsPerTorrent: Int, val maxUploads: Int, val maxUploadsPerTorrent: Int, val stopTrackerTimeout: Int, val enablePieceExtentAffinity: Boolean, val bittorrentProtocol: BittorrentProtocol, val limitUtpRate: Boolean, val limitTcpOverhead: Boolean, val limitLanPeers: Boolean, val altDlLimit: Int, val altUpLimit: Int, val schedulerEnabled: Boolean, val scheduleFromHour: Int, val scheduleFromMin: Int, val scheduleToHour: Int, val scheduleToMin: Int, val schedulerDays: SchedulerDays, val dht: Boolean, val pex: Boolean, val lsd: Boolean, val encryption: TorrentEncryption, val anonymousMode: Boolean, val proxyType: ProxyType, val proxyIp: String, val proxyPort: Int, val proxyPeerConnections: Boolean, val proxyAuthEnabled: Boolean, val proxyUsername: String, val proxyPassword: String, val proxyTorrentsOnly: Boolean? = null, val ipFilterEnabled: Boolean, val ipFilterPath: String, val ipFilterTrackers: Boolean, val webUiDomainList: List<String>, val webUiAddress: String, val webUiPort: Int, val webUiUpnp: Boolean, val webUiUsername: String, val webUiPassword: String? = null, val webUiCsrfProtectionEnabled: Boolean, val webUiClickjackingProtectionEnabled: Boolean, val webUiSecureCookieEnabled: Boolean, val webUiMaxAuthFailCount: Int, val webUiBanDuration: Int, val webUiSessionTimeout: Int, val webUiHostHeaderValidationEnabled: Boolean, val bypassLocalAuth: Boolean, val bypassAuthSubnetWhitelistEnabled: Boolean, val bypassAuthSubnetWhitelist: List<String>, val alternativeWebUiEnabled: Boolean, val alternativeWebUiPath: String, val useHttps: Boolean, val webUiHttpsKeyPath: String, val webUiHttpsCertPath: String, val dyndnsEnabled: Boolean, val dyndnsService: DyndnsService, val dyndnsUsername: String, val dyndnsPassword: String, val dyndnsDomain: String, val rssRefreshInterval: Int, val rssMaxArticlesPerFeed: Int, val rssProcessingEnabled: Boolean, val rssAutoDownloadingEnabled: Boolean, val rssDownloadRepackProperEpisodes: Boolean, val rssSmartEpisodeFilters: String, val addTrackersEnabled: Boolean, val addTrackers: List<String>, val webUiUseCustomHttpHeadersEnabled: Boolean, val webUiCustomHttpHeaders: List<String>, val maxSeedingTimeEnabled: Boolean, val maxSeedingTime: Int, val announceIp: String, val announceToAllTiers: Boolean, val announceToAllTrackers: Boolean, val asyncIoThreads: Int, val bannedIps: List<String>, val checkingMemoryUse: Int, val currentInterfaceAddress: String, val currentNetworkInterface: String, val diskCache: Int, val diskCacheTtl: Int, val embeddedTrackerPort: Int, val enableCoalesceReadWrite: Boolean, val enableEmbeddedTracker: Boolean, val enableMultiConnectionsFromSameIp: Boolean, val enableOsCache: Boolean? = null, val enableUploadSuggestions: Boolean, val filePoolSize: Int, val outgoingPortsMax: Int, val outgoingPortsMin: Int, val recheckCompletedTorrents: Boolean, val resolvePeerCountries: Boolean, val saveResumeDataInterval: Int, val sendBufferLowWatermark: Int, val sendBufferWatermark: Int, val sendBufferWatermarkFactor: Int, val socketBacklogSize: Int, val uploadChokingAlgorithm: UploadChokingAlgorithm, val uploadSlotsBehavior: UploadSlotsBehavior, val upnpLeaseDuration: Int, val utpTcpMixedMode: UtpTcpMixedMode)

QBittorrentPrefsBuilder

class QBittorrentPrefsBuilder

ServerState

@Serializable

class ServerState(val allTimeDownload: Long, val allTimeUpload: Long, val averageTimeInQueue: Int, val connectionStatus: ConnectionStatus, val dhtNodes: Int, val dlInfoData: Long, val dlInfoSpeed: Long, val dlRateLimit: Long, val freeSpace: Long, val globalShareRatio: String, val queuedIoJobs: Int, val queueing: Boolean, val readCacheHits: String, val readCacheOverload: String, val refreshInterval: Int, val totalBuffersSize: Int, val totalPeerConnections: Int, val totalQueuedSize: Int, val sessionWaste: Long, val upInfoData: Long, val upInfoSpeed: Long, val upRateLimit: Int, val useAltSpeedLimits: Boolean, val writeCacheOverload: String)

Torrent

@Serializable

class Torrent(val addedOn: Long, val amountLeft: Long, val autoTmm: Boolean, val availability: Float, val category: String, val completed: Long, val completedOn: Long, val contentPath: String, val dlLimit: Long, val dlspeed: Long, val downloaded: Float, val downloadedSession: Float, val eta: Long, val firstLastPiecePriority: Boolean, val forceStart: Boolean, val hash: String, val lastActivity: Long, val magnetUri: String, val maxRatio: Float, val maxSeedingTime: Long, val name: String, val seedsInSwarm: Int, val leechersInSwarm: Int, val connectedLeechers: Int, val connectedSeeds: Int, val priority: Int, val progress: Float, val ratio: Float, val ratioLimit: Float, val savePath: String, val seedingTimeLimit: Long, val seenCompleted: Long, val sequentialDownload: Boolean, val size: Long, val state: Torrent.State, val superSeeding: Boolean, val tags: List<String>, val timeActive: Long, val seedingTime: Long, val totalSize: Long, val tracker: String, val uploadLimit: Long, val uploaded: Long, val uploadedSession: Long, val uploadSpeed: Long)

TorrentFile

@Serializable

class TorrentFile(val index: Int, val name: String, val size: Long, val progress: Float, val priority: Int, val isSeeding: Boolean? = false, val pieceRange: List<Int>, val availability: Float)

TorrentFilter

enum TorrentFilter : Enum<TorrentFilter>

TorrentPeer

@Serializable

class TorrentPeer(val client: String = "", val connection: String = "", val country: String = "", val countryCode: String = "", val dlSpeed: Long = 0, val downloaded: Long = 0, val files: String = "", val flags: String = "", val flagsDesc: String = "", val ip: String = "", val port: Int = 0, val progress: Float = 0.0f, val relevance: Float = 0.0f, val upSpeed: Long = 0, val uploaded: Long = 0)

TorrentPeers

@Serializable

class TorrentPeers(val fullUpdate: Boolean = false, val rid: Int = 0, val showFlags: Boolean = false, val peers: Map<String, TorrentPeer> = emptyMap(), val peersRemoved: List<String> = emptyList())

TorrentProperties

@Serializable

class TorrentProperties(val savePath: String, val creationDate: Long, val pieceSize: Long, val comment: String, val totalWasted: Long, val totalUploaded: Long, val totalUploadedSession: Long, val totalDownloaded: Long, val totalDownloadedSession: Long, val upLimit: Long, val dlLimit: Long, val timeElapsed: Long, val seedingTime: Long, val nbConnections: Int, val nbConnectionsLimit: Int, val shareRatio: Float, val additionDate: Long, val completionDate: Long, val createdBy: String, val dlSpeedAvg: Long, val dlSpeed: Long, val eta: Long, val lastSeen: Long, val peers: Int, val peersTotal: Int, val piecesHave: Int, val piecesNum: Int, val reannounce: Long, val seeds: Int, val seedsTotal: Int, val totalSize: Long, val upSpeedAvg: Long, val upSpeed: Long)

TorrentTracker

@Serializable

class TorrentTracker(val url: String, val status: TrackerStatus, val tier: Int, val numPeers: Int, val numSeeds: Int, val numLeeches: Int, val numDownloaded: Int, val msg: String = "")

TrackerStatus

enum TrackerStatus : Enum<TrackerStatus>

Webseed

@Serializable

class Webseed(val url: String)

Properties

serialName

val KProperty1<Torrent, *>.serialName: String

Returns the serial name for the given model property to use with API calls requiring field names such as sorting in getTorrents(...).