Bug 1884412 - Remove recommendation to move messages to trash from WebExtension API documentation. r=aleca

Following feedback from developers, we remove the recommendation to
manually move messages to trash. Instead, developers should use the
standard `browser.messages.delete()` function, which honors the user's
trash settings.

Differential Revision: https://phabricator.services.mozilla.com/D204077

--HG--
extra : amend_source : 1b7ea551cff50620be932ad6a0282dec4e43bd6b
This commit is contained in:
John Bieling 2024-03-10 12:41:00 +02:00
Родитель 3e7c075b21
Коммит 9aeed72f36
1 изменённых файлов: 1 добавлений и 1 удалений

Просмотреть файл

@ -902,7 +902,7 @@
{
"name": "delete",
"type": "function",
"description": "Deletes messages permanently, or moves them to the trash folder (honoring the account's deletion behavior settings). Deleting external messages will throw an <em>ExtensionError</em>. The ``skipTrash`` parameter allows immediate permanent deletion, bypassing the trash folder.\n**Note**: Consider using :ref:`messages.move` to manually move messages to the account's trash folder, instead of requesting the overly powerful permission to actually delete messages. The account's trash folder can be extracted as follows: <literalinclude>includes/messages/getTrash.js<lang>JavaScript</lang></literalinclude>",
"description": "Deletes messages permanently, or moves them to the trash folder (honoring the account's deletion behavior settings). Deleting external messages will throw an <em>ExtensionError</em>. The ``skipTrash`` parameter allows immediate permanent deletion, bypassing the trash folder.",
"async": true,
"permissions": ["messagesDelete"],
"parameters": [