Ignore:
Timestamp:
Jan 19, 2013, 8:43:26 AM (9 years ago)
Author:
jordan
Message:

(trunk) #1220 'change top folder names' -- added support for this in libtransmission's C and RPC APIs.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/extras/rpc-spec.txt

    r13787 r13807  
    407407   Request arguments:
    408408
    409    string                     | value type & description
    410    ---------------------------+-------------------------------------------------
    411    "ids"                      | array      torrent list, as described in 3.1
    412    "location"                 | string     the new torrent location
    413    "move"                     | boolean    if true, move from previous location.
    414                               |            otherwise, search "location" for files
    415                               |            (default: false)
     409   string                           | value type & description
     410   ---------------------------------+-------------------------------------------------
     411   "ids"                            | array      torrent list, as described in 3.1
     412   "location"                       | string     the new torrent location
     413   "move"                           | boolean    if true, move from previous location.
     414                                    |            otherwise, search "location" for files
     415                                    |            (default: false)
     416
     417   Response arguments: none
     418
     419
     4203.7.  Renaming a Torrent's Path
     421
     422   Method name: "torrent-rename-path"
     423
     424   For more information on the use of this function, see the
     425   transmission.h documentation of tr_torrentRenamePath()
     426
     427   Request arguments:
     428
     429   string                           | value type & description
     430   ---------------------------------+-------------------------------------------------
     431   "ids"                            | array      the torrent torrent list, as described in 3.1
     432                                    |            (though, this function doesn't make sense for >1 torrent)
     433   "path"                           | string     the path to the file or folder that will be renamed
     434   "name"                           | string     the file or folder's new name
    416435
    417436   Response arguments: none
     
    582601  The following changes have been made to the RPC interface:
    583602
    584    RPC   | Release | Backwards |                |
    585    Vers. | Version | Compat?   | Method         | Description
    586    ------+---------+-----------+----------------+-------------------------------
    587    1     | 1.30    | n/a       | n/a            | Initial version
    588    ------+---------+-----------+----------------+-------------------------------
    589    2     | 1.34    | yes       | torrent-get    | new arg "peers"
    590    ------+---------+-----------+----------------+-------------------------------
    591    3     | 1.41    | yes       | torrent-get    | added "port" to "peers"
    592          |         | yes       | torrent-get    | new arg "downloaders"
    593          |         | yes       | session-get    | new arg "version"
    594          |         | yes       | torrent-remove | new method
    595    ------+---------+-----------+----------------+-------------------------------
    596    4     | 1.50    | yes       | session-get    | new arg "rpc-version"
    597          |         | yes       | session-get    | new arg "rpc-version-minimum"
    598          |         | yes       | session-stats  | added "cumulative-stats"
    599          |         | yes       | session-stats  | added "current-stats"
    600          |         | yes       | torrent-get    | new arg "downloadDir"
    601    ------+---------+-----------+----------------+-------------------------------
    602    5     | 1.60    | yes       |                | new method "torrent-reannounce"
    603          |         | yes       |                | new method "blocklist-update"
    604          |         | yes       |                | new method "port-test"
    605          |         |           |                |
    606          |         | yes       | session-get    | new arg "alt-speed-begin"
    607          |         | yes       | session-get    | new arg "alt-speed-down"
    608          |         | yes       | session-get    | new arg "alt-speed-enabled"
    609          |         | yes       | session-get    | new arg "alt-speed-end"
    610          |         | yes       | session-get    | new arg "alt-speed-time-enabled"
    611          |         | yes       | session-get    | new arg "alt-speed-up"
    612          |         | yes       | session-get    | new arg "blocklist-enabled"
    613          |         | yes       | session-get    | new arg "blocklist-size"
    614          |         | yes       | session-get    | new arg "peer-limit-per-torrent"
    615          |         | yes       | session-get    | new arg "seedRatioLimit"
    616          |         | yes       | session-get    | new arg "seedRatioLimited"
    617          |         |        NO | session-get    | renamed "pex-allowed" to "pex-enabled"
    618          |         |        NO | session-get    | renamed "port" to "peer-port"
    619          |         |        NO | session-get    | renamed "peer-limit" to "peer-limit-global"
    620          |         |           |                |
    621          |         | yes       | torrent-add    | new arg "files-unwanted"
    622          |         | yes       | torrent-add    | new arg "files-wanted"
    623          |         | yes       | torrent-add    | new arg "priority-high"
    624          |         | yes       | torrent-add    | new arg "priority-low"
    625          |         | yes       | torrent-add    | new arg "priority-normal"
    626          |         |           |                |
    627          |         | yes       | torrent-set    | new arg "bandwidthPriority"
    628          |         | yes       | torrent-set    | new arg "honorsSessionLimits"
    629          |         | yes       | torrent-set    | new arg "seedRatioLimit"
    630          |         | yes       | torrent-set    | new arg "seedRatioLimited"
    631          |         |        NO | torrent-set    | renamed "speed-limit-down" to "downloadLimit"
    632          |         |        NO | torrent-set    | renamed "speed-limit-down-enabled" to "downloadLimited"
    633          |         |        NO | torrent-set    | renamed "speed-limit-up" to "uploadLimit"
    634          |         |        NO | torrent-set    | renamed "speed-limit-up-enabled" to "uploadLimited"
    635          |         |           |                |
    636          |         | yes       | torrent-get    | new arg "bandwidthPriority"
    637          |         | yes       | torrent-get    | new arg "fileStats"
    638          |         | yes       | torrent-get    | new arg "honorsSessionLimits"
    639          |         | yes       | torrent-get    | new arg "percentDone"
    640          |         | yes       | torrent-get    | new arg "pieces"
    641          |         | yes       | torrent-get    | new arg "seedRatioLimit"
    642          |         | yes       | torrent-get    | new arg "seedRatioMode"
    643          |         | yes       | torrent-get    | new arg "torrentFile"
    644          |         | yes       | torrent-get    | new ids option "recently-active"
    645          |         |        NO | torrent-get    | removed arg "downloadLimitMode"
    646          |         |        NO | torrent-get    | removed arg "uploadLimitMode"
    647    ------+---------+-----------+----------------+-------------------------------
    648    6     | 1.70    | yes       |                | new "method torrent-set-location"
    649    ------+---------+-----------+----------------+-------------------------------
    650    7     | 1.80    |        NO | torrent-get    | removed arg "announceResponse"
    651          |         |        NO | torrent-get    | removed arg "announceURL"
    652          |         |        NO | torrent-get    | removed arg "downloaders"
    653          |         |        NO | torrent-get    | removed arg "lastAnnounceTime"
    654          |         |        NO | torrent-get    | removed arg "lastScrapeTime"
    655          |         |        NO | torrent-get    | removed arg "leechers"
    656          |         |        NO | torrent-get    | removed arg "nextAnnounceTime"
    657          |         |        NO | torrent-get    | removed arg "nextScrapeTime"
    658          |         |        NO | torrent-get    | removed arg "scrapeResponse"
    659          |         |        NO | torrent-get    | removed arg "scrapeURL"
    660          |         |        NO | torrent-get    | removed arg "seeders"
    661          |         |        NO | torrent-get    | removed arg "timesCompleted"
    662          |         |        NO | torrent-get    | removed arg "swarmSpeed"
    663          |         | yes       | torrent-get    | new arg "magnetLink"
    664          |         | yes       | torrent-get    | new arg "metadataPercentComplete"
    665          |         | yes       | torrent-get    | new arg "trackerStats"
    666          |         | yes       | session-set    | new arg "incomplete-dir"
    667          |         | yes       | session-set    | new arg "incomplete-dir-enabled"
    668    ------+---------+-----------+----------------+-------------------------------
    669    8     | 1.90    | yes       | session-set    | new arg "rename-partial-files"
    670          |         | yes       | session-get    | new arg "rename-partial-files"
    671          |         | yes       | session-get    | new arg "config-dir"
    672          |         | yes       | torrent-add    | new arg "bandwidthPriority"
    673          |         | yes       | torrent-get    | new trackerStats arg "lastAnnounceTimedOut"
    674    ------+---------+-----------+----------------+-------------------------------
    675    8     | 1.92    | yes       | torrent-get    | new trackerStats arg "lastScrapeTimedOut"
    676    ------+---------+-----------+----------------+-------------------------------
    677    9     | 2.00    | yes       | session-set    | new arg "start-added-torrents"
    678          |         | yes       | session-set    | new arg "trash-original-torrent-files"
    679          |         | yes       | session-get    | new arg "start-added-torrents"
    680          |         | yes       | session-get    | new arg "trash-original-torrent-files"
    681          |         | yes       | torrent-get    | new arg "isFinished"
    682    ------+---------+-----------+----------------+-------------------------------
    683    10    | 2.10    | yes       | session-get    | new arg "cache-size-mb"
    684          |         | yes       | torrent-set    | new arg "trackerAdd"
    685          |         | yes       | torrent-set    | new arg "trackerRemove"
    686          |         | yes       | torrent-set    | new arg "trackerReplace"
    687          |         | yes       | session-set    | new arg "idle-seeding-limit"
    688          |         | yes       | session-set    | new arg "idle-seeding-limit-enabled"
    689          |         | yes       | session-get    | new arg "units"
    690          |         | yes       | torrent-set    | new arg "seedIdleLimit"
    691          |         | yes       | torrent-set    | new arg "seedIdleMode"
    692    ------+---------+-----------+----------------+-------------------------------
    693    11    | 2.12    | yes       | session-get    | new arg "blocklist-url"
    694          |         | yes       | session-set    | new arg "blocklist-url"
    695    ------+---------+-----------+----------------+-------------------------------
    696    12    | 2.20    | yes       | session-get    | new arg "download-dir-free-space"
    697          |         | yes       | session-close  | new method
    698    ------+---------+-----------+----------------+-------------------------------
    699    13    | 2.30    | yes       | session-get    | new arg "isUTP" to the "peers" list
    700          |         | yes       | torrent-add    | new arg "cookies"
    701          |         |        NO | torrent-get    | removed arg "peersKnown"
    702    ------+---------+-----------+----------------+-------------------------------
    703    14    | 2.40    |        NO | torrent-get    | values of "status" field changed
    704          |         | yes       | torrent-get    | new arg "queuePosition"
    705          |         | yes       | torrent-get    | new arg "isStalled"
    706          |         | yes       | torrent-get    | new arg "fromLpd" in peersFrom
    707          |         | yes       | torrent-set    | new arg "queuePosition"
    708          |         | yes       | session-set    | new arg "download-queue-size"
    709          |         | yes       | session-set    | new arg "download-queue-enabled"
    710          |         | yes       | session-set    | new arg "seed-queue-size"
    711          |         | yes       | session-set    | new arg "seed-queue-enabled"
    712          |         | yes       | session-set    | new arg "queue-stalled-enabled"
    713          |         | yes       | session-set    | new arg "queue-stalled-minutes"
    714          |         | yes       |                | new method "queue-move-top"
    715          |         | yes       |                | new method "queue-move-up"
    716          |         | yes       |                | new method "queue-move-down"
    717          |         | yes       |                | new method "queue-move-bottom"
    718          |         | yes       |                | new method "torrent-start-now"
    719    ------+---------+-----------+----------------+-------------------------------
    720    15    | 2.80    | yes       | torrent-get    | new arg "etaIdle"
    721 
     603   RPC   | Release | Backwards |                      |
     604   Vers. | Version | Compat?   | Method               | Description
     605   ------+---------+-----------+----------------------+-------------------------------
     606   1     | 1.30    | n/a       | n/a                  | Initial version
     607   ------+---------+-----------+----------------------+-------------------------------
     608   2     | 1.34    | yes       | torrent-get          | new arg "peers"
     609   ------+---------+-----------+----------------------+-------------------------------
     610   3     | 1.41    | yes       | torrent-get          | added "port" to "peers"
     611         |         | yes       | torrent-get          | new arg "downloaders"
     612         |         | yes       | session-get          | new arg "version"
     613         |         | yes       | torrent-remove       | new method
     614   ------+---------+-----------+----------------------+-------------------------------
     615   4     | 1.50    | yes       | session-get          | new arg "rpc-version"
     616         |         | yes       | session-get          | new arg "rpc-version-minimum"
     617         |         | yes       | session-stats        | added "cumulative-stats"
     618         |         | yes       | session-stats        | added "current-stats"
     619         |         | yes       | torrent-get          | new arg "downloadDir"
     620   ------+---------+-----------+----------------------+-------------------------------
     621   5     | 1.60    | yes       |                      | new method "torrent-reannounce"
     622         |         | yes       |                      | new method "blocklist-update"
     623         |         | yes       |                      | new method "port-test"
     624         |         |           |                      |
     625         |         | yes       | session-get          | new arg "alt-speed-begin"
     626         |         | yes       | session-get          | new arg "alt-speed-down"
     627         |         | yes       | session-get          | new arg "alt-speed-enabled"
     628         |         | yes       | session-get          | new arg "alt-speed-end"
     629         |         | yes       | session-get          | new arg "alt-speed-time-enabled"
     630         |         | yes       | session-get          | new arg "alt-speed-up"
     631         |         | yes       | session-get          | new arg "blocklist-enabled"
     632         |         | yes       | session-get          | new arg "blocklist-size"
     633         |         | yes       | session-get          | new arg "peer-limit-per-torrent"
     634         |         | yes       | session-get          | new arg "seedRatioLimit"
     635         |         | yes       | session-get          | new arg "seedRatioLimited"
     636         |         |        NO | session-get          | renamed "pex-allowed" to "pex-enabled"
     637         |         |        NO | session-get          | renamed "port" to "peer-port"
     638         |         |        NO | session-get          | renamed "peer-limit" to "peer-limit-global"
     639         |         |           |                      |
     640         |         | yes       | torrent-add          | new arg "files-unwanted"
     641         |         | yes       | torrent-add          | new arg "files-wanted"
     642         |         | yes       | torrent-add          | new arg "priority-high"
     643         |         | yes       | torrent-add          | new arg "priority-low"
     644         |         | yes       | torrent-add          | new arg "priority-normal"
     645         |         |           |                      |
     646         |         | yes       | torrent-set          | new arg "bandwidthPriority"
     647         |         | yes       | torrent-set          | new arg "honorsSessionLimits"
     648         |         | yes       | torrent-set          | new arg "seedRatioLimit"
     649         |         | yes       | torrent-set          | new arg "seedRatioLimited"
     650         |         |        NO | torrent-set          | renamed "speed-limit-down" to "downloadLimit"
     651         |         |        NO | torrent-set          | renamed "speed-limit-down-enabled" to "downloadLimited"
     652         |         |        NO | torrent-set          | renamed "speed-limit-up" to "uploadLimit"
     653         |         |        NO | torrent-set          | renamed "speed-limit-up-enabled" to "uploadLimited"
     654         |         |           |                      |
     655         |         | yes       | torrent-get          | new arg "bandwidthPriority"
     656         |         | yes       | torrent-get          | new arg "fileStats"
     657         |         | yes       | torrent-get          | new arg "honorsSessionLimits"
     658         |         | yes       | torrent-get          | new arg "percentDone"
     659         |         | yes       | torrent-get          | new arg "pieces"
     660         |         | yes       | torrent-get          | new arg "seedRatioLimit"
     661         |         | yes       | torrent-get          | new arg "seedRatioMode"
     662         |         | yes       | torrent-get          | new arg "torrentFile"
     663         |         | yes       | torrent-get          | new ids option "recently-active"
     664         |         |        NO | torrent-get          | removed arg "downloadLimitMode"
     665         |         |        NO | torrent-get          | removed arg "uploadLimitMode"
     666   ------+---------+-----------+----------------------+-------------------------------
     667   6     | 1.70    | yes       |                      | new "method torrent-set-location"
     668   ------+---------+-----------+----------------------+-------------------------------
     669   7     | 1.80    |        NO | torrent-get          | removed arg "announceResponse"
     670         |         |        NO | torrent-get          | removed arg "announceURL"
     671         |         |        NO | torrent-get          | removed arg "downloaders"
     672         |         |        NO | torrent-get          | removed arg "lastAnnounceTime"
     673         |         |        NO | torrent-get          | removed arg "lastScrapeTime"
     674         |         |        NO | torrent-get          | removed arg "leechers"
     675         |         |        NO | torrent-get          | removed arg "nextAnnounceTime"
     676         |         |        NO | torrent-get          | removed arg "nextScrapeTime"
     677         |         |        NO | torrent-get          | removed arg "scrapeResponse"
     678         |         |        NO | torrent-get          | removed arg "scrapeURL"
     679         |         |        NO | torrent-get          | removed arg "seeders"
     680         |         |        NO | torrent-get          | removed arg "timesCompleted"
     681         |         |        NO | torrent-get          | removed arg "swarmSpeed"
     682         |         | yes       | torrent-get          | new arg "magnetLink"
     683         |         | yes       | torrent-get          | new arg "metadataPercentComplete"
     684         |         | yes       | torrent-get          | new arg "trackerStats"
     685         |         | yes       | session-set          | new arg "incomplete-dir"
     686         |         | yes       | session-set          | new arg "incomplete-dir-enabled"
     687   ------+---------+-----------+----------------------+-------------------------------
     688   8     | 1.90    | yes       | session-set          | new arg "rename-partial-files"
     689         |         | yes       | session-get          | new arg "rename-partial-files"
     690         |         | yes       | session-get          | new arg "config-dir"
     691         |         | yes       | torrent-add          | new arg "bandwidthPriority"
     692         |         | yes       | torrent-get          | new trackerStats arg "lastAnnounceTimedOut"
     693   ------+---------+-----------+----------------------+-------------------------------
     694   8     | 1.92    | yes       | torrent-get          | new trackerStats arg "lastScrapeTimedOut"
     695   ------+---------+-----------+----------------------+-------------------------------
     696   9     | 2.00    | yes       | session-set          | new arg "start-added-torrents"
     697         |         | yes       | session-set          | new arg "trash-original-torrent-files"
     698         |         | yes       | session-get          | new arg "start-added-torrents"
     699         |         | yes       | session-get          | new arg "trash-original-torrent-files"
     700         |         | yes       | torrent-get          | new arg "isFinished"
     701   ------+---------+-----------+----------------------+-------------------------------
     702   10    | 2.10    | yes       | session-get          | new arg "cache-size-mb"
     703         |         | yes       | torrent-set          | new arg "trackerAdd"
     704         |         | yes       | torrent-set          | new arg "trackerRemove"
     705         |         | yes       | torrent-set          | new arg "trackerReplace"
     706         |         | yes       | session-set          | new arg "idle-seeding-limit"
     707         |         | yes       | session-set          | new arg "idle-seeding-limit-enabled"
     708         |         | yes       | session-get          | new arg "units"
     709         |         | yes       | torrent-set          | new arg "seedIdleLimit"
     710         |         | yes       | torrent-set          | new arg "seedIdleMode"
     711   ------+---------+-----------+----------------------+-------------------------------
     712   11    | 2.12    | yes       | session-get          | new arg "blocklist-url"
     713         |         | yes       | session-set          | new arg "blocklist-url"
     714   ------+---------+-----------+----------------------+-------------------------------
     715   12    | 2.20    | yes       | session-get          | new arg "download-dir-free-space"
     716         |         | yes       | session-close        | new method
     717   ------+---------+-----------+----------------------+-------------------------------
     718   13    | 2.30    | yes       | session-get          | new arg "isUTP" to the "peers" list
     719         |         | yes       | torrent-add          | new arg "cookies"
     720         |         |        NO | torrent-get          | removed arg "peersKnown"
     721   ------+---------+-----------+--------------------------+-------------------------------
     722   14    | 2.40    |        NO | torrent-get          | values of "status" field changed
     723         |         | yes       | torrent-get          | new arg "queuePosition"
     724         |         | yes       | torrent-get          | new arg "isStalled"
     725         |         | yes       | torrent-get          | new arg "fromLpd" in peersFrom
     726         |         | yes       | torrent-set          | new arg "queuePosition"
     727         |         | yes       | session-set          | new arg "download-queue-size"
     728         |         | yes       | session-set          | new arg "download-queue-enabled"
     729         |         | yes       | session-set          | new arg "seed-queue-size"
     730         |         | yes       | session-set          | new arg "seed-queue-enabled"
     731         |         | yes       | session-set          | new arg "queue-stalled-enabled"
     732         |         | yes       | session-set          | new arg "queue-stalled-minutes"
     733         |         | yes       |                      | new method "queue-move-top"
     734         |         | yes       |                      | new method "queue-move-up"
     735         |         | yes       |                      | new method "queue-move-down"
     736         |         | yes       |                      | new method "queue-move-bottom"
     737         |         | yes       |                      | new method "torrent-start-now"
     738   ------+---------+-----------+--------------------------+-------------------------------
     739   15    | 2.80    | yes       | torrent-get          | new arg "etaIdle"
     740         |         | yes       | torrent-rename-path  | new method
     741
Note: See TracChangeset for help on using the changeset viewer.