khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

feat: document newly added send mail and share api changes into app upgrade guide

Browse Source 
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
This commit is contained in:
skjnldsv
2024-07-19 17:16:57 +02:00
parent 9f3c117202
commit bcfe9b332b
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_30.rst
View File

@@ -104,6 +104,7 @@ Added APIs
- ``OCP\AppFramework\Http\Attribute\ExAppRequired`` attribute for restricting controller methods to be only accessible by ExApps.
- ``OCP\Collaboration\Reference\IPublicReferenceProvider`` added for reference providers that support reference lookups from public shares.
- ``OCP\Files\IFilenameValidator`` was added to allow storage independent filename validation.
- ``ShareAPIController::sendShareEmail`` was added and is accessible via ocs ``/api/v1/shares/{shareId}/send-email``. See :ref:`send-email<Send email>` documentation.
Changed APIs
^^^^^^^^^^^^
@@ -125,6 +126,7 @@ Changed APIs
- Calling ``OCP\Notification\INotification::setIcon()`` with a relative URL is deprecated and will throw ``OCP\Notification\InvalidValueException`` in a future version.
- ``OCP\Notification\INotifier::prepare()`` should no longer throw ``\InvalidArgumentException``. ``OCP\Notification\UnknownNotificationException`` should be thrown when the notifier does not want to handle the notification. ``\InvalidArgumentException`` are logged as debug for now and will be logged as error in the future to help developers find issues from code that unintentionally threw ``\InvalidArgumentException``
- ``OCP\IGroupManager::isAdmin()`` should be used instead of checking is current user is part of admin group manually.
- ``IAttributes`` ``enabled`` key have bee renamed to ``value`` and supports more than boolean.
Deprecated APIs
^^^^^^^^^^^^^^^

4
developer_manual/client_apis/OCS/ocs-share-api.rst
View File

@@ -131,7 +131,7 @@ Update a given share. Only one value can be updated per request.
shares. This argument expects a well formatted date string, e.g. 'YYYY-MM-DD'
* PUT Arguments: note - (string) Adds a note for the share recipient.
* PUT Arguments: attributes - (string) serialized JSON string for :ref:`share attributes<Share attributes>`
* PUT Arguments: sendMail - (string) send an email to the recipient. This will not send an email on its own. You will have to use the `send-email` endpoint to send the email. (true/false)
* PUT Arguments: sendMail - (string) send an email to the recipient. This will not send an email on its own. You will have to use the :ref:`send-email<Send email>` endpoint to send the email. (true/false)
.. note:: Only one of the update parameters can be specified at once.
@@ -155,7 +155,7 @@ Share attributes are used for more advanced flags like permissions.
{ "scope": "permissions", "key": "download", "value": false }
]
.. warning:: Since Nextcloud 30, the `enabled` key have bee renamed to `value` and supports more than boolean.
.. warning:: Since Nextcloud 30, the ``enabled`` key have bee renamed to ``value`` and supports more than boolean.
Download permission
"""""""""""""""""""