add a doc string
This commit is contained in:
parent
b4e56e923b
commit
96b38188fc
|
@ -362,6 +362,13 @@ class WebApi(JSONComponent):
|
||||||
|
|
||||||
@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)
|
||||||
|
|
Loading…
Reference in New Issue