Changeset 7331 for trunk/doc/rpc-spec.txt

Timestamp:

Dec 9, 2008, 5:01:49 PM (12 years ago)

Author:

charles

Message:

(daemon) #1510: kysucix's patch to give an option to delete local data via RPC when removing a torrent.

File:

• trunk/doc/rpc-spec.txt (modified) (2 diffs)

trunk/doc/rpc-spec.txt

@@ -69 +69 @@
    Method name         | libtransmission function
    --------------------+-------------------------------------------------
-   "torrent-remove"    | tr_torrentRemove
    "torrent-start"     | tr_torrentStart
    "torrent-stop"      | tr_torrentStop
@@ -294 +293 @@
                        fields for id, name, and hashString.
 
+3.5.  Removing a Torrent
+
+   Method name: "torrent-remove"
+
+   Request arguments:
+
+   string                     | value type & description
+   ---------------------------+-------------------------------------------------
+   "ids"                      | array      torrent list, as described in 3.1
+   "delete-local-data"        | 'boolean'  delete local data. (default: false)
+
+   Response arguments: none
+
 
 4.   Session Requests