diff --git a/docs/web_api.md b/docs/web_api.md index 9f49553..70f1950 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -704,21 +704,43 @@ clients of the change: `{jsonrpc: "2.0", method: "notify_filelist_changed", params: []}` -The param is an object in the following format: +The param is an object in the following format, where +the "action" is the operation that prompted the change, and the "item" +contains information about the item that has changed: ```json -{action: "", filename: "", root: ""} +{action: "", + item: { + path: "", + root: "", + size: , + modified: "" + } ``` -Note that file move/copy actions also include the name and root of the -previous/source file: +Note that file move and copy actions also include a "source item" that +contains the path and root of the source file or directory. ```json -{action: "", filename: "", root: "", - prev_file: "", prev_root: ""} +{action: "", + item: { + path: "", + root: "", + size: , + modified: "" + }, + source_item: { + path: "", + root: "" + } +} ``` -The `action` is the operation that resulted in a file list change, the `filename` -is the name of the file the action was performed on, and the `filelist` is the current -file list, returned in the same format as `get_file_list`. +The following `actions` are currently available: +- `upload_file` +- `delete_file` +- `create_dir` +- `delete_dir` +- `move_item` +- `copy_item` # Appendix