Robot
/
freebox_api_php
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update FsTask service Documentation

This commit is contained in:
alphayax 2016-06-12 16:28:58 +02:00
parent af7a15c8e8
commit 6f19bfcdb7
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
freebox/api/v3/services/FileSystem/FileSystemTask.php
View File

@ -13,7 +13,7 @@ class FileSystemTask extends Service {
const API_FS_TASK = '/api/v3/fs/tasks/'; const API_FS_TASK = '/api/v3/fs/tasks/';
/** /**
* @throws \Exception * Retrieve all FS tasks
* @return models\FileSystem\FsTask[] * @return models\FileSystem\FsTask[]
*/ */
public function getAllTasks(){ public function getAllTasks(){
@ -24,6 +24,7 @@ class FileSystemTask extends Service {
} }
/** /**
* Retrieve a FS task with the specified id
* @param int $TaskId * @param int $TaskId
* @return models\FileSystem\FsTask * @return models\FileSystem\FsTask
*/ */
@ -35,6 +36,7 @@ class FileSystemTask extends Service {
} }
/** /**
* Delete a FS task
* @param models\FileSystem\FsTask $FsTask * @param models\FileSystem\FsTask $FsTask
* @return bool * @return bool
*/ */
@ -43,6 +45,7 @@ class FileSystemTask extends Service {
} }
/** /**
* Delete a FS task with the specified id
* @param int $TaskId * @param int $TaskId
* @return bool * @return bool
*/ */
@ -54,6 +57,7 @@ class FileSystemTask extends Service {
} }
/** /**
* Update a FS task
* @param models\FileSystem\FsTask $FsTask * @param models\FileSystem\FsTask $FsTask
* @return bool * @return bool
*/ */