mirror of
https://github.com/codex-storage/deluge.git
synced 2025-02-17 13:56:47 +00:00
update json docs
This commit is contained in:
parent
f7066242da
commit
c266bd489f
@ -60,7 +60,7 @@ def json_response(result, id):
|
|||||||
"id":id
|
"id":id
|
||||||
})
|
})
|
||||||
|
|
||||||
def json_error(message , id , msg_number=123):
|
def json_error(message , id=-1, msg_number=123):
|
||||||
log.error("JSON-error:%s" % message)
|
log.error("JSON-error:%s" % message)
|
||||||
print json.write({
|
print json.write({
|
||||||
"version":"1.1",
|
"version":"1.1",
|
||||||
@ -81,10 +81,11 @@ class json_rpc:
|
|||||||
"""
|
"""
|
||||||
#extra exposed methods
|
#extra exposed methods
|
||||||
json_exposed = ["update_ui","get_stats","system_listMethods"]
|
json_exposed = ["update_ui","get_stats","system_listMethods"]
|
||||||
|
cache = {}
|
||||||
|
|
||||||
|
|
||||||
def GET(self):
|
def GET(self):
|
||||||
print '{"error":"only POST is supported"}'
|
return json_error("only POST is supported")
|
||||||
|
|
||||||
|
|
||||||
def POST(self , name=None):
|
def POST(self , name=None):
|
||||||
@ -139,7 +140,20 @@ class json_rpc:
|
|||||||
return sclient.list_methods() + self.json_exposed
|
return sclient.list_methods() + self.json_exposed
|
||||||
|
|
||||||
def get_stats(self):
|
def get_stats(self):
|
||||||
"returns global stats dict"
|
"""
|
||||||
|
returns:
|
||||||
|
{{{
|
||||||
|
{
|
||||||
|
'download_rate':float(),
|
||||||
|
'upload_rate':float(),
|
||||||
|
'max_download':float(),
|
||||||
|
'max_upload':float(),
|
||||||
|
'num_connections':int(),
|
||||||
|
'max_num_connections':int(),
|
||||||
|
'dht_nodes',int()
|
||||||
|
}
|
||||||
|
}}}
|
||||||
|
"""
|
||||||
stats = {}
|
stats = {}
|
||||||
|
|
||||||
aclient.get_download_rate(dict_cb('download_rate',stats))
|
aclient.get_download_rate(dict_cb('download_rate',stats))
|
||||||
@ -161,14 +175,14 @@ class json_rpc:
|
|||||||
"""
|
"""
|
||||||
Composite call.
|
Composite call.
|
||||||
Goal : limit the number of ajax calls
|
Goal : limit the number of ajax calls
|
||||||
=== input ===
|
|
||||||
|
input:
|
||||||
{{{
|
{{{
|
||||||
keys: see get_torrent_status
|
keys: see get_torrent_status
|
||||||
filter_dict: see label_get_filtered_ids # only effective if the label plugin is enabled.
|
filter_dict: see label_get_filtered_ids # only effective if the label plugin is enabled.
|
||||||
cache_id: # todo
|
cache_id: # todo
|
||||||
}
|
|
||||||
}}}
|
}}}
|
||||||
=== output ===
|
returns:
|
||||||
{{{
|
{{{
|
||||||
{
|
{
|
||||||
"torrents": see get_torrent_status
|
"torrents": see get_torrent_status
|
||||||
|
@ -90,11 +90,16 @@ function update_ui() {
|
|||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
<h1>sclient:</h1>
|
|
||||||
|
<h1>ui.client</h1>
|
||||||
|
<a href="http://dev.deluge-torrent.org/wiki/Development/UiClient#Remoteapi">docs</a> <br>
|
||||||
|
|
||||||
<button onclick="get_session_state()">get_session_state()</button>
|
<button onclick="get_session_state()">get_session_state()</button>
|
||||||
|
|
||||||
<button onclick="list_torrents()">List torrents using get_session_state() + get_torrents_status()</button> <br>
|
<button onclick="list_torrents()">List torrents using get_session_state() + get_torrents_status()</button> <br>
|
||||||
<h1>json extra:</h1>
|
<h1>json extra:</h1>
|
||||||
|
|
||||||
|
<a href="http://dev.deluge-torrent.org/wiki/Development/WebUi/Json">Docs</a><br>
|
||||||
<button onclick="get_stats()">get_stats()</button>
|
<button onclick="get_stats()">get_stats()</button>
|
||||||
|
|
||||||
<button onclick="update_ui()">update_ui() filter on "Seeding"</button>
|
<button onclick="update_ui()">update_ui() filter on "Seeding"</button>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user