Changes between Version 1 and Version 2 of XmlRpc

Show
Ignore:
Timestamp:
07/30/09 00:21:09 (14 months ago)
Author:
guest
Comment:

added a quick listing of all commands

Legend:

Unmodified
Added
Removed
Modified
  • XmlRpc

    v1 v2  
    5656 'uptime': '00:43', 
    5757 'version': '0.9-trunk'} 
     58 
     59>>> for x in hellanzbServer.system.listMethods(): 
     60...   print x 
     61...   print hellanzbServer.system.methodSignature(x) 
     62...   print hellanzbServer.system.methodHelp(x) 
     63...  
     64force 
     65[['struct', 'string'], ['struct', 'int']] 
     66 Force hellanzb to begin downloading the NZB with the specified ID immediately, 
     67        interrupting the current download  
     68process 
     69[['struct', 'string'], ['struct', 'string', 'string']] 
     70 Post process the specified directory. The -p option is preferable -- it will do this 
     71        for you, or use the current process if this XML-RPC call fails  
     72dequeue 
     73[['list', 'string'], ['list', 'int']] 
     74 Remove the NZB with specified ID from the queue  
     75move 
     76[['list', 'string', 'string'], ['list', 'int', 'int']] 
     77 Move the NZB with the specified ID to the specified index in the queue  
     78down 
     79[['list', 'string'], ['list', 'int'], ['list', 'string', 'string'], ['list', 'int', 'int']] 
     80 Move the NZB with the specified ID down in the queue. The optional second argument 
     81        specifies the number of spaces to shift by (Default: 1)  
     82cancel 
     83[['struct']] 
     84 Cancel the current download and move the current NZB to Hellanzb.TEMP_DIR  
     85shutdown 
     86[['boolean']] 
     87 Shutdown hellanzb. Will quietly kill any post processing threads that may exist  
     88asciiart 
     89[['string']] 
     90 Return a random ascii art  
     91aolsay 
     92[['string']] 
     93 Return a random aolsay (from Da5id's aolsay.scr)  
     94setrarpass 
     95[['struct', 'int', 'string'], ['struct', 'string', 'string']] 
     96 Set the rarPassword for the NZB with the specified ID  
     97enqueueurl 
     98[['struct', 'string']] 
     99 Download the NZB at the specified URL, and enqueue it  
     100next 
     101[['list', 'string'], ['list', 'int']] 
     102 Move the NZB with the specified ID to the beginning of the queue  
     103maxrate 
     104[['int'], ['int', 'string'], ['int', 'int']] 
     105 Return the Hellanzb.MAX_RATE (maximum download rate) value. Specify a second argument 
     106        to change the value -- a value of zero denotes no maximum rate  
     107status 
     108[['struct']] 
     109 Return hellanzb's current status text  
     110enqueuenewzbin 
     111[['struct', 'string'], ['struct', 'int']] 
     112 Download the NZB with the specified NZB ID from www.newzbin.com, and enqueue it  
     113enqueue 
     114[['struct', 'string'], ['struct', 'string', 'string']] 
     115 Add the specified NZB file to the end of the queue  
     116pause 
     117[['struct']] 
     118 Pause downloading  
     119last 
     120[['list', 'string'], ['list', 'int']] 
     121 Move the NZB with the specified ID to the end of the queue  
     122clear 
     123[['struct'], ['struct', 'boolean']] 
     124 Clear the current nzb queue. Specify True as the second argument to clear anything 
     125        currently downloading as well (like the cancel call)  
     126list 
     127[['list'], ['list', 'boolean']] 
     128 List the NZBs in the queue, along with their NZB IDs. Specify True as the second 
     129        argument to exclude the NZB ID in the listing. Returns a list of structs (nzbid -> nzbName). Excluding the NZB IDs returns a list of nzbName strings 
     130up 
     131[['list', 'string'], ['list', 'int'], ['list', 'string', 'string'], ['list', 'int', 'int']] 
     132 Move the NZB with the specified ID up in the queue. The optional second argument 
     133        specifies the number of spaces to shift by (Default: 1)  
     134continue 
     135[['struct']] 
     136 Continue downloading after being paused  
     137system.methodHelp 
     138[['string', 'string']] 
     139Return a documentation string describing the use of the given method. 
     140         
     141system.listMethods 
     142[['array']] 
     143Return a list of the method names implemented by this server. 
     144system.methodSignature 
     145[['array', 'string'], ['string', 'string']] 
     146Return a list of type signatures. 
     147 
     148        Each type signature is a list of the form [rtype, type1, type2, ...] 
     149        where rtype is the return type and typeN is the type of the Nth 
     150        argument. If no signature information is available, the empty 
     151        string is returned. 
     152 
     153 
    58154}}} 
    59155