summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authorGravatar RaNaN <Mast3rRaNaN@hotmail.de> 2013-01-03 21:00:58 +0100
committerGravatar RaNaN <Mast3rRaNaN@hotmail.de> 2013-01-03 21:00:58 +0100
commit7c6374b4b5d452ab239f8b725038f2a2eb82368f (patch)
tree392f5809fb908eb7f22dffd273821bcc831da3dc /docs/api
parentseperate api into several components (diff)
downloadpyload-7c6374b4b5d452ab239f8b725038f2a2eb82368f.tar.xz
split api into more components
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/components.rst9
-rw-r--r--docs/api/datatypes.rst26
2 files changed, 19 insertions, 16 deletions
diff --git a/docs/api/components.rst b/docs/api/components.rst
index 90994b0df..116cfa90b 100644
--- a/docs/api/components.rst
+++ b/docs/api/components.rst
@@ -10,4 +10,11 @@ of the available components listed by topic can be found below.
:toctree: module
module.api.CoreApi.CoreApi
- module.api.ConfigApi.ConfigApi \ No newline at end of file
+ module.api.ConfigApi.ConfigApi
+ module.api.DownloadPreparingApi.DownloadPreparingApi
+ module.api.DownloadApi.DownloadApi
+ module.api.FileApi.FileApi
+ module.api.CollectorApi.CollectorApi
+ module.api.AccountApi.AccountApi
+ module.api.UserInteractionApi.UserInteractionApi
+ module.api.AddonApi.AddonApi \ No newline at end of file
diff --git a/docs/api/datatypes.rst b/docs/api/datatypes.rst
index da8fe1aba..d4df56905 100644
--- a/docs/api/datatypes.rst
+++ b/docs/api/datatypes.rst
@@ -341,7 +341,7 @@ for various languages. It is also a good overview of avaible methods and return
service Pyload {
///////////////////////
- // Server Status
+ // Core Status
///////////////////////
string getServerVersion(),
@@ -391,7 +391,7 @@ for various languages. It is also a good overview of avaible methods and return
map<string, LinkList> generatePackages(1: LinkList links),
///////////////////////
- // Adding/Deleting
+ // Download
///////////////////////
list<PackageID> generateAndAddPackages(1: LinkList links, 2: bool paused),
@@ -415,6 +415,15 @@ for various languages. It is also a good overview of avaible methods and return
void deleteFiles(1: list<FileID> fids),
void deletePackages(1: list<PackageID> pids), // delete the whole folder recursive
+ // Modify Downloads
+
+ void restartPackage(1: PackageID pid),
+ void restartFile(1: FileID fid),
+ void recheckPackage(1: PackageID pid),
+ void restartFailed(),
+ void stopDownloads(1: list<FileID> fids),
+ void stopAllDownloads(),
+
///////////////////////
// Collector
///////////////////////
@@ -447,20 +456,7 @@ for various languages. It is also a good overview of avaible methods and return
TreeCollection findFiles(1: string pattern),
TreeCollection findPackages(1: list<string> tags),
- ///////////////////////
- // Modify Downloads
- ///////////////////////
-
- void restartPackage(1: PackageID pid),
- void restartFile(1: FileID fid),
- void recheckPackage(1: PackageID pid),
- void restartFailed(),
- void stopDownloads(1: list<FileID> fids),
- void stopAllDownloads(),
-
- /////////////////////////
// Modify Files/Packages
- /////////////////////////
// moving package while downloading is not possible, so they will return bool to indicate success
void updatePackage(1: PackageInfo pack) throws (1: PackageDoesNotExists e),