2016-06-11 21:29:34 +02:00
# FileSystem
2016-06-11 23:16:01 +02:00
**Namespace** : alphayax\freebox\api\v3\services\FileSystem
# Overview
- [FileSharingLink ](FileSystem.md#FileSharingLink )
- [FileSystemListing ](FileSystem.md#FileSystemListing )
- [FileSystemOperation ](FileSystem.md#FileSystemOperation )
- [FileSystemTask ](FileSystem.md#FileSystemTask )
- [FileUpload ](FileSystem.md#FileUpload )
2016-06-11 21:29:34 +02:00
2016-06-11 23:16:01 +02:00
< a name = "FileSharingLink" > < / a >
2016-06-11 21:29:34 +02:00
## FileSharingLink
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSharingLink
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getAll` | Retrieve a File Sharing link |
| `getFromToken` | |
2016-06-11 23:16:01 +02:00
| `deleteFromToken` | Delete a File Sharing link Deletes the ShareLink task with the given token, if the task was running, stop it. |
2016-06-11 21:29:34 +02:00
| `create` | Create a File Sharing link |
2016-06-11 23:16:01 +02:00
< a name = "FileSystemListing" > < / a >
2016-06-11 21:29:34 +02:00
## FileSystemListing
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemListing
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getFilesFromDirectory` | |
| `getFileInformation` | Get file information |
2016-06-11 23:16:01 +02:00
< a name = "FileSystemOperation" > < / a >
2016-06-11 21:29:34 +02:00
## FileSystemOperation
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemOperation
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `move` | Move files |
| `copy` | Copy files |
| `remove` | Delete files |
| `cat` | Concatenate files (Miaw ^^) |
| `archive` | Create an archive |
| `extract` | Extract an archive |
| `repair` | Repair files from a .par2 |
2016-06-11 23:16:01 +02:00
| `computeHash` | Hash a file. This operation can take some time. To get the hash value, the returned task must have succeed and be in the state “done”. |
| `getHashValue` | Get the hash value To get the hash, the task must have succeed and be in the state “done”. |
| `createDirectory` | Create a directory Contrary to other file system tasks, this operation is done synchronously. |
| `rename` | Rename a file/folder Contrary to other file system tasks, this operation is done synchronously. |
2016-06-11 21:29:34 +02:00
| `download` | Download a file from the freebox server |
2016-06-11 23:16:01 +02:00
< a name = "FileSystemTask" > < / a >
2016-06-11 21:29:34 +02:00
## FileSystemTask
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\FileSystem\FileSystemTask
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getAllTasks` | |
| `getTaskById` | |
| `deleteTask` | |
| `deleteTaskById` | |
| `updateTask` | |
2016-06-11 23:16:01 +02:00
< a name = "FileUpload" > < / a >
2016-06-11 21:29:34 +02:00
## FileUpload
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\FileSystem\FileUpload
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `createAuthorization` | Create a file upload authorization |
| `uploadFile` | Send the content of the FileUpload task |
| `getAll` | Get the list of uploads |
| `getFromId` | Track an upload status |
2016-06-11 23:16:01 +02:00
| `cancelFromId` | Cancel the given FileUpload closing the connection The upload status must be in_progress |
2016-06-11 21:29:34 +02:00
| `deleteFromId` | Delete the given FileUpload closing the connection if needed |
| `cleanTerminated` | Deletes all the FileUpload not in_progress |
