diff options
author | Lorenz Diener <[email protected]> | 2017-11-21 14:22:58 +0100 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2017-11-21 14:22:58 +0100 |
commit | 962212c5754183607488272b3c1592d569dd8a24 (patch) | |
tree | 654a51dde22cb5bda8d5444938d66f187319b2d7 | |
parent | e31b9441f8db1a7778a29331a3a2200b6d8fed97 (diff) | |
download | mastodon.py-962212c5754183607488272b3c1592d569dd8a24.tar.gz |
Emoji dict documentation
-rw-r--r-- | docs/index.rst | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst index 34b7b38..5ead443 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -186,17 +186,18 @@ Toot dicts | |||
186 | 'spoiler_text': # Warning text that should be displayed before the toot content | 186 | 'spoiler_text': # Warning text that should be displayed before the toot content |
187 | 'visibility': # Toot visibility ('public', 'unlisted', 'private', or 'direct') | 187 | 'visibility': # Toot visibility ('public', 'unlisted', 'private', or 'direct') |
188 | 'mentions': # A list of users dicts mentioned in the toot, as Mention dicts | 188 | 'mentions': # A list of users dicts mentioned in the toot, as Mention dicts |
189 | 'media_attachments': # list of media dicts of attached files. Only present | 189 | 'media_attachments': # A list of media dicts of attached files |
190 | # when there are attached files. | 190 | 'emojis': # A list of custom emojis used in the toot, as Emoji dicts |
191 | 'tags': # A list of hashtag used in the toot, as Hashtag dicts | 191 | 'tags': # A list of hashtag used in the toot, as Hashtag dicts |
192 | 'application': # Application dict for the client used to post the toot | 192 | 'application': # Application dict for the client used to post the toot |
193 | 'language': # The language of the toot, if specified by the server. | 193 | 'language': # The language of the toot, if specified by the server. |
194 | 'muted': # Boolean denoting whether the user has muted this status by way of conversation muting. | 194 | 'muted': # Boolean denoting whether the user has muted this status by way of conversation muting |
195 | } | 195 | } |
196 | 196 | ||
197 | Mention dicts | 197 | Mention dicts |
198 | ~~~~~~~~~~~~~ | 198 | ~~~~~~~~~~~~~ |
199 | .. code-block:: python | 199 | .. code-block:: python |
200 | |||
200 | { | 201 | { |
201 | 'url': # Mentioned users profile URL (potentially remote) | 202 | 'url': # Mentioned users profile URL (potentially remote) |
202 | 'username': # Mentioned users user name (not including domain) | 203 | 'username': # Mentioned users user name (not including domain) |
@@ -207,10 +208,21 @@ Mention dicts | |||
207 | Hashtag dicts | 208 | Hashtag dicts |
208 | ~~~~~~~~~~~~~ | 209 | ~~~~~~~~~~~~~ |
209 | .. code-block:: python | 210 | .. code-block:: python |
211 | |||
210 | { | 212 | { |
211 | 'name': # Hashtag name (not including the #) | 213 | 'name': # Hashtag name (not including the #) |
212 | 'url': # Hashtag URL (can be remote) | 214 | 'url': # Hashtag URL (can be remote) |
213 | } | 215 | } |
216 | |||
217 | Emoji dicts | ||
218 | ~~~~~~~~~~~ | ||
219 | .. code-block:: python | ||
220 | |||
221 | { | ||
222 | 'shortcode': # Emoji shortcode, without surrounding colons. | ||
223 | 'url': # URL for the emoji image, can be animated | ||
224 | 'static_url': # URL for the emoji image, never animated | ||
225 | } | ||
214 | 226 | ||
215 | Relationship dicts | 227 | Relationship dicts |
216 | ~~~~~~~~~~~~~~~~~~ | 228 | ~~~~~~~~~~~~~~~~~~ |
@@ -262,7 +274,7 @@ Media dicts | |||
262 | # Returns the following dictionary: | 274 | # Returns the following dictionary: |
263 | { | 275 | { |
264 | 'id': # The ID of the attachment. | 276 | 'id': # The ID of the attachment. |
265 | 'type': # Media type: 'image', 'video' or 'gifv' | 277 | 'type': # Media type: 'image', 'video', 'gifv' or 'unknown'. |
266 | 'url': # The URL for the image in the local cache | 278 | 'url': # The URL for the image in the local cache |
267 | 'remote_url': # The remote URL for the media (if the image is from a remote instance) | 279 | 'remote_url': # The remote URL for the media (if the image is from a remote instance) |
268 | 'preview_url': # The URL for the media preview | 280 | 'preview_url': # The URL for the media preview |