diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_27.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_27.rst index fafca709024..115956d32db 100644 --- a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_27.rst +++ b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_27.rst @@ -25,13 +25,7 @@ Front-end changes Added APIs ^^^^^^^^^^ -* A new Files Router API allows you to control the files router service and update views, querys or param without page reload (`nextcloud/server#37824 `_) - - .. code-block:: js - - // https://github.com/nextcloud/server/blob/master/apps/files/src/services/RouterService.ts - OCP.Files.Router.goTo('/trashbin?dir=/Unsplash.d1680193199') - OCP.Files.Router.goToRoute('fileslist', { view: 'files' }, { dir: '/Folders/Group folder' }) +* A new Files Router API allows you to control the files router service and update views, querys or param without page reload. See :ref:`FilesAPI` Back-end changes ---------------- diff --git a/developer_manual/client_apis/activity-api.rst b/developer_manual/client_apis/activity-api.rst index 9d1c4f5d9be..d71d6fe9cfc 100644 --- a/developer_manual/client_apis/activity-api.rst +++ b/developer_manual/client_apis/activity-api.rst @@ -1,5 +1,5 @@ -============ -Activity API -============ +======== +Activity +======== Find the documentation in the `Activity app repo `__. diff --git a/developer_manual/client_apis/files.rst b/developer_manual/client_apis/files.rst new file mode 100644 index 00000000000..e7281fcb4eb --- /dev/null +++ b/developer_manual/client_apis/files.rst @@ -0,0 +1,62 @@ +.. _FilesAPI: + +===== +Files +===== + +.. sectionauthor:: John Molakvoæ +.. versionadded:: 27 + +Since Nextcloud 27, the files app has been rewritten to use new standards +and frameworks. This means that the old documentation is no longer valid. +We will update and document the new files app APIs and methods here. + +.. note:: Some external libraries offers in-depth technical documentation. + Please have a look at the following: + + * https://github.com/nextcloud/nextcloud-files (`documentation `__) + * https://github.com/nextcloud/nextcloud-upload + + +Router +^^^^^^ + +To change views and parameters of the current Files app, we expose the router. +This directly maps to the Vue router. You can check their own `documentation `__ to +better understand the methods. + +.. code-block:: ts + + /** + * Trigger a route change on the files app + * + * @param path the url path, eg: '/trashbin?dir=/Deleted' + * @param replace replace the current history + * @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location + */ + goTo(path: string, replace: boolean = false): Promise + + /** + * Trigger a route change on the files App + * + * @param name the route name + * @param params the route parameters + * @param query the url query parameters + * @param replace replace the current history + * @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location + */ + goToRoute( + name?: string, + params?: Dictionary, + query?: Dictionary, + replace?: boolean, + ): Promise + + +Examples +-------- + +.. code-block:: js + + OCP.Files.Router.goTo('/trashbin?dir=/Unsplash.d1680193199') + OCP.Files.Router.goToRoute('fileslist', { view: 'files' }, { dir: '/Folders/Group folder' }) diff --git a/developer_manual/client_apis/index.rst b/developer_manual/client_apis/index.rst index f7a8761f921..95f4ee646fa 100644 --- a/developer_manual/client_apis/index.rst +++ b/developer_manual/client_apis/index.rst @@ -8,10 +8,11 @@ Clients and Client APIs :maxdepth: 2 general + activity-api android_library/index - WebDAV/index - OCS/index + files LoginFlow/index + OCS/index RemoteWipe/index - activity-api + WebDAV/index