codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add a doc string

This commit is contained in:
Damien Churchill 2009-04-28 15:59:56 +00:00
parent b4e56e923b
commit 96b38188fc
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
deluge/ui/web/json_api.py
View File

@ -361,7 +361,14 @@ class WebApi(JSONComponent):
d.callback(file_tree.get_tree()) d.callback(file_tree.get_tree())
@export @export
def get_torrent_files(self, torrent_id): def get_torrent_files(self, torrent_id):
"""
Gets the files for a torrent in tree format
:param torrent_id: string, the id of the torrent to retrieve.
:returns: The torrents files in a tree
:rtype: dict
"""
main_deferred = Deferred() main_deferred = Deferred()
d = client.core.get_torrent_status(torrent_id, FILES_KEYS) d = client.core.get_torrent_status(torrent_id, FILES_KEYS)
d.addCallback(self._on_got_files, main_deferred) d.addCallback(self._on_got_files, main_deferred)