jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 09:46:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add media_description (#37276)

Browse Source
This commit is contained in:
Andrew Jackson 2025-02-09 23:02:37 +00:00 committed by GitHub
parent dc1c2ba09c
commit 4bfc6d7301
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_integrations/mastodon.markdown
View File

@ -58,14 +58,15 @@ The previous `notify.mastodon` service has been deprecated in favor of the new `
Post a status to your Mastodon account Post a status to your Mastodon account
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
|------------------------|----------|-------------| | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `config_entry_id` | No | The ID of the Mastodon config entry to post to. | | `config_entry_id` | No | The ID of the Mastodon config entry to post to. |
| `status` | No | The status text to post. | | `status` | No | The status text to post. |
| `visibility` | Yes | If not used, will default to account setting. `public`: post will be public, `unlisted`: post will be public but not appear on the public timeline, `private`: post will only be visible to followers, and `direct`: post will only be visible to mentioned users. | | `visibility` | Yes | If not used, will default to account setting. `public`: post will be public, `unlisted`: post will be public but not appear on the public timeline, `private`: post will only be visible to followers, and `direct`: post will only be visible to mentioned users. |
| `content_warning` | Yes | Text will be shown as a warning before the text of the status. If not used, no warning will be displayed. | | `content_warning` | Yes | Text will be shown as a warning before the text of the status. If not used, no warning will be displayed. |
| `media` | Yes | Attach an image or video to the post. | | `media` | Yes | Attach an image or video to the post. |
| `media_warning` | Yes | If an image or video is attached, `True` will mark the media as sensitive. `False` is default. | | `media_description` | Yes | If an image or video is attached, will add a description for this media for people with visual impairments. |
| `media_warning` | Yes | If an image or video is attached, `True` will mark the media as sensitive. `False` is default. |
{% tip %} {% tip %}
You can get your `config_entry_id` by using actions within [Developer Tools](/docs/tools/dev-tools/), using one of the above actions and viewing the YAML. You can get your `config_entry_id` by using actions within [Developer Tools](/docs/tools/dev-tools/), using one of the above actions and viewing the YAML.
@ -125,7 +126,7 @@ This will post a status to Mastodon that includes an image.
{% details "Example post with media and a content warning that will not be visible in the public timeline" %} {% details "Example post with media and a content warning that will not be visible in the public timeline" %}
This will post a status to Mastodon that includes an image, with a content warning and a visibility of `unlisted`, so it doesn't show in the public timeline. This will post a status to Mastodon that includes an image, with a description, a content warning, and a visibility of `unlisted`, so it doesn't show in the public timeline.
{% raw %} {% raw %}
@ -135,6 +136,7 @@ This will post a status to Mastodon that includes an image, with a content warni
status: "A media toot from Home Assistant" status: "A media toot from Home Assistant"
visibility: unlisted visibility: unlisted
media: /config/www/funny_meme.png media: /config/www/funny_meme.png
media_description: "A funny meme"
content_warning: "This might not be funny enough" content_warning: "This might not be funny enough"
``` ```