From 7c6374b4b5d452ab239f8b725038f2a2eb82368f Mon Sep 17 00:00:00 2001 From: RaNaN Date: Thu, 3 Jan 2013 21:00:58 +0100 Subject: split api into more components --- docs/api/components.rst | 9 ++++++++- docs/api/datatypes.rst | 26 +++++++++++--------------- 2 files changed, 19 insertions(+), 16 deletions(-) (limited to 'docs/api') 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 generatePackages(1: LinkList links), /////////////////////// - // Adding/Deleting + // Download /////////////////////// list 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 fids), void deletePackages(1: list 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 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 tags), - /////////////////////// - // Modify Downloads - /////////////////////// - - void restartPackage(1: PackageID pid), - void restartFile(1: FileID fid), - void recheckPackage(1: PackageID pid), - void restartFailed(), - void stopDownloads(1: list 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), -- cgit v1.2.3