feat: add files api

Signed-off-by: John Molakvoæ <[email protected]>

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 <https:/nextcloud/server/pull/37824>`_)
-
- .. code-block:: js
-
- // https:/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
 ----------------

developer_manual/client_apis/activity-api.rst

@@ -1,5 +1,5 @@
-============
-Activity API
-============
+========
+Activity
+========
 
 Find the documentation in the `Activity app repo <https:/nextcloud/activity/blob/master/docs/endpoint-v2.md>`__.

developer_manual/client_apis/files.rst

@@ -0,0 +1,61 @@
+.. _FilesAPI:
+
+=====
+Files
+=====
+
+.. sectionauthor:: John Molakvoæ <[email protected]>
+
+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:/nextcloud/nextcloud-files (`documentation <https://nextcloud.github.io/nextcloud-files/>`_)
+ * https:/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 <https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location>`_ 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<Route>
+
+ /**
+ * 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<string>,
+ query?: Dictionary<string | (string | null)[] | null | undefined>,
+ replace?: boolean,
+ ): Promise<Route>
+
+
+Examples
+--------
+
+.. code-block:: js
+
+ OCP.Files.Router.goTo('/trashbin?dir=/Unsplash.d1680193199')
+ OCP.Files.Router.goToRoute('fileslist', { view: 'files' }, { dir: '/Folders/Group folder' })

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