![]() To mark a new result as read you would use the following script In this case the 'subscription_id' and 'subscription_result_id(s)' are supplied automatically. ![]() Subscriptions have an "execute on new result" item allowing a script to be specified via a right-click menu item. This is identical to the above method but with the name set to 'markresultsreadinall' Invocation from Subscriptions Method=markresultsread&subscription_id=&subscription_result_id= method=markresultsread&subscription_id=&subscription_result_ids= Mark Result Read In All Subscriptions Multiple commands can be executed by semi-colon separating them. Or, since 3201_B34, to play a sound when a download is assigned to a Tag: ![]() Plugin( simpleapi, "method=setnetworks&networks=I2P" ) For example, to invoke the 'setnetworks' method to set the download's networks to 'I2P you would use the following script Also as it applies to a specific download the 'hash' is implicit. Given that this is an internal invocation the 'apikey' is not required. Rather than continually extending the 'execute on assign' Tag function with more and more features it made sense to enhance the existing 'script' option to invoke SimpleAPI features directly. Method=alert&caption=&type=&details= Invocation from Tags To raise an alert against a download: (details is optional) ![]() skipped: whether the file is downloaded or not value true/false.datapath: value=absolute file path for the file's data.Method=setdownloadfileattribute&hash=&index=&name=&value=* You can set a download's file attributes: The optional parameter "calc_root_hashes" can be supplied to force a V2 root file hash to be computed for V1 torrents. You can list a download's files with the result being returned as a JSON array: Method=listdownloads List a Download's Files You can list downloads with the result being returned as a JSON array: ipfilterenable: whether or not the download's IP filter is enabled value=true/false.savepath: download save path - rename the download name/folder only, can't be used to generally move the download location.completedon: value=seconds since January 1st 1970.Method=setdownloadattribute&hash=&name=&value=* Method=setnetworks&hash=&networks= Set a Download's Attributesįor simple attributes this method can be used: To set a download's networks (valid networks are "Public", "I2P" and "Tor"): Method=setcategory&hash=&category= Set Networks To set a download's category: (Use "" for uncategorized): To add a tag to a download the remainder of the URL is Typically the plugin will accept connections to local host on the (default) port of 6906: Operations are performed via a simple URL and currently the response is via HTTP code - 200 indicates success. You can set this to whatever you want or use the suggested value. The intent is that it would be called from a local script - the external plugin "BiglyBT Web Remote" has a very extensive API for interacting with BiglyBT but is more complicated to use, hence the addition of this plugin.Īn 'apikey' is required for all operations as a security measure, this can be found in the plugin configuration under Plugins->Simple API. This was added in 2801_B20 to initially support a the adding of a tag or category to a download but can easily be extended. Others have separate repositories and documentation, see įor example, the 'Command Runner' plugin can be found at Įxternal plugins can be installed by going to the Tools menu and selecting Plugins->Get Plugins Built In Plugins Simple API Some are actually built into BiglyBT and don't need installing. BiglyBT supports various plugins to extend its features.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |