fix(developer): Deprecate OC.dialogs

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
nextcloud · Apr 9, 2024 · 47b39e3 · 47b39e3
1 parent 1e10a39
commit 47b39e3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_30.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_30.rst
@@ -20,6 +20,20 @@ Removed APIs
 Removed globals
 ^^^^^^^^^^^^^^^
 
+Deprecated APIs
+^^^^^^^^^^^^^^^
+
+* Most ``OC.dialogs`` API is now deprecated and will be removed in the future. For generic dialogs use the ``DialogBuilder`` from the :ref:`js-library_nextcloud-dialogs`.
+  A list of the now deprecated methods:
+
+  * ``OC.dialogs.alert``
+  * ``OC.dialogs.info``
+  * ``OC.dialogs.confirm``
+  * ``OC.dialogs.confirmDestructive``
+  * ``OC.dialogs.confirmHtml``
+  * ``OC.dialogs.prompt``
+  * ``OC.dialogs.message``
+
 Back-end changes
 ----------------
 

diff --git a/developer_manual/digging_deeper/javascript-apis.rst b/developer_manual/digging_deeper/javascript-apis.rst
@@ -57,6 +57,8 @@ This package provides an `Axios <https://www.npmjs.com/package/axios>`_ HTTP cli
 
 This package provides a simple event bus implementation that integrates with server and other apps. Thus it is one of the recommended ways of inter-app communication. Documentation: https://nextcloud.github.io/nextcloud-event-bus/
 
+.. _js-library_nextcloud-dialogs:
+
 ``@nextcloud/dialogs``
 ^^^^^^^^^^^^^^^^^^^^^^