TransmissionRpcClient class abstract interface

A Transmission RPC client implemented in Dart, visit rpc-spec.md obtain more information.

usage example:

void main() async {
  final client = TransmissionRpcClient();
  await client.init();
  assert(client.isInited(), true);
}

Available extensions

Constructors

TransmissionRpcClient({HttpProtocol protocol = HttpProtocol.http, String? username, String? password, String host = "127.0.0.1", int port = 9091, String path = "/transmission/rpc", int maxRetryCount = 10, int timeout = 10000, Logger? log}): factory

Properties

hashCode → int: The hash code for this object.
no setterinherited
maxRetryCount → int: no setter
password → String?: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serverRpcVersion → ServerRpcVersion?: no setter
timeout → int: no setter
url → Uri: no setter
username → String?: no setter

Methods

blocklistUpdate({RpcTag? tag, int? timeout}) → Future<BlocklistUpdateResponse>: Update blocklist (if setting blocklist-url). more info see: blocklist-update
callApi<T extends RequestParam, V extends ResponseParam>(T? p, {required TransmissionRpcMethod method, required RpcTag? tag, required int? timeout, V responseParamBuilder(JsonMap rawParam)?}) → Future<ApiResponse<T, V>>: Available on TransmissionRpcClient, provided by the TransmissionRpcClientFrameExtension extension
checkAndCallApi<T extends RequestParam, V extends ResponseParam>(T? p, {required TransmissionRpcMethod method, required RpcTag? tag, required int? timeout, V responseParamBuilder(JsonMap rawParam)?}) → Future<ApiResponse<T, V>>: Available on TransmissionRpcClient, provided by the TransmissionRpcClientFrameExtension extension
doRequest(TransmissionRpcRequest<RequestParam> request, {int? timeout}) → Future<JsonMap>
freeSpace(String path, {RpcTag? tag, int? timeout}) → Future<FreeSpaceResponse>: Tests how much free space is available in a client-specified folder. more info see: free-space
groupGet(List<String>? group, {RpcTag? tag, int? timeout}) → Future<GroupGetResponse>: Get bandwidth group. more info see: group-get
groupSet(GroupSetRequestArgs args, {RpcTag? tag, int? timeout}) → Future<GroupSetResponse>: Set bandwith group more info see: group-set
init() → Future<void>
isInited() → bool
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
portTest({RpcTag? tag, int? timeout}) → Future<PortTestResponse>: Test to see if your incoming peer port is accessible. more info see: port-test
preCheck(TransmissionRpcMethod method, RequestParam? p, {int? timeout}) → void
queueMoveBottom(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<QueueMoveResponse<QueueMoveBottomReqeustParam>>: Move torrent at bottom of queue. more info see: queue-move-bottom
queueMoveDown(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<QueueMoveResponse<QueueMoveDownReqeustParam>>: Move torrent down from queue. more info see: queue-move-down
queueMoveTop(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<QueueMoveResponse<QueueMoveTopReqeustParam>>: Move torretns at top of queue. more info see: queue-move-top
queueMoveUp(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<QueueMoveResponse<QueueMoveUpReqeustParam>>: Move torrents up from queue. more info see: queue-move-up
sessionClose({RpcTag? tag, int? timeout}) → Future<SessionCloseResponse>: Tells the transmission session to shutdown. more info see: session-close
sessionGet(List<SessionGetArgument>? fields, {RpcTag? tag, int? timeout}) → Future<SessionGetResponse>: Get session running stats by given fields. more info see: session-get
sessionSet(SessionSetRequestArgs args, {RpcTag? tag, int? timeout}) → Future<SessionSetResponse>: Set sesion running stats. more info see: session-set
sessionStats({RpcTag? tag, int? timeout}) → Future<SessionStatsResponse>: Get sssion statistics more info see: session-stats
torrentAdd(TorrentAddRequestArgs args, {RpcTag? tag, int? timeout}) → Future<TorrentAddResponse>: Adding a torrent. more info see: torrent-add
torrentGet(List<TorrentGetArgument> fields, {TorrentIds<TorrentId>? ids, RpcTag? tag, int? timeout}) → Future<TorrentGetResponse>: Get torrents info. more info see: torrent-get
torrentGetAll(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<TorrentGetResponse>: Available on TransmissionRpcClient, provided by the TransmissionRpcTorrentExtension extension
torrentReannounce(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<TorrentActionResponse<TorrentReannounceRequestParam>>: Re-announce to trackers now. more info see: torrent-reannounce
torrentRemove(TorrentIds<TorrentId> ids, {bool? deleteLocalData, RpcTag? tag, int? timeout}) → Future<TorrentRemoveResponse>: Removing a torrent. more info see: torrent-remove
torrentRenamePath(TorrentRenamePathArgs args, {RpcTag? tag, int? timeout}) → Future<TorrentRenamePathResponse>: Renaming a torrent's path. more info see: torrent-rename-path
torrentSet(TorrentSetRequestArgs args, {RpcTag? tag, int? timeout}) → Future<TorrentSetResponse>: Set torrents info. more info see: torrent-set
torrentSetLocation(TorrentSetLocationArgs args, {RpcTag? tag, int? timeout}) → Future<TorrentSetLocationResponse>: Moving a torrent. more info see: torrent-set-location
torrentStart(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<TorrentActionResponse<TorrentStartRequestParam>>: Start a torrent. more info see: torrent-start
torrentStartNow(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<TorrentActionResponse<TorrentStartNowRequestParam>>: Start start torrent disregarding queue position. more info see: torrent-start-now
torrentStop(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<TorrentActionResponse<TorrentStopRequestParam>>: Stop torrent. more info see: torrent-stop
torrentVerify(TorrentIds<TorrentId> ids, {RpcTag? tag, int? timeout}) → Future<TorrentActionResponse<TorrentVerifyRequestParam>>: Verify torrent. more info see: torrent-verify
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

TransmissionRpcClient class abstract interface

Constructors

Properties

Methods

Operators

client library