diff options
Diffstat (limited to 'docs/05_statuses.rst')
| -rw-r--r-- | docs/05_statuses.rst | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/05_statuses.rst b/docs/05_statuses.rst new file mode 100644 index 0000000..5615a9f --- /dev/null +++ b/docs/05_statuses.rst | |||
| @@ -0,0 +1,84 @@ | |||
| 1 | Statuses, media and polls | ||
| 2 | ========================= | ||
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 5 | |||
| 6 | Statuses | ||
| 7 | -------- | ||
| 8 | These functions allow you to get information about single statuses and to post and update them, as well as to favourite, bookmark, mute reblog ("boost") and to undo all of those. | ||
| 9 | For status pinning, check out TODO and TODO on the accounts page. | ||
| 10 | |||
| 11 | Reading | ||
| 12 | ~~~~~~~ | ||
| 13 | .. automethod:: Mastodon.status | ||
| 14 | .. automethod:: Mastodon.status_context | ||
| 15 | .. automethod:: Mastodon.status_reblogged_by | ||
| 16 | .. automethod:: Mastodon.status_favourited_by | ||
| 17 | .. automethod:: Mastodon.status_card | ||
| 18 | .. automethod:: Mastodon.status_history | ||
| 19 | .. automethod:: Mastodon.status_source | ||
| 20 | |||
| 21 | .. automethod:: Mastodon.favourites | ||
| 22 | |||
| 23 | .. automethod:: Mastodon.bookmarks | ||
| 24 | |||
| 25 | Writing | ||
| 26 | ~~~~~~~ | ||
| 27 | .. _status_post(): | ||
| 28 | .. automethod:: Mastodon.status_post | ||
| 29 | .. automethod:: Mastodon.status_reply | ||
| 30 | .. automethod:: Mastodon.toot | ||
| 31 | .. _make_poll(): | ||
| 32 | .. automethod:: Mastodon.make_poll | ||
| 33 | |||
| 34 | .. automethod:: Mastodon.status_reblog | ||
| 35 | .. automethod:: Mastodon.status_unreblog | ||
| 36 | |||
| 37 | .. automethod:: Mastodon.status_favourite | ||
| 38 | .. automethod:: Mastodon.status_unfavourite | ||
| 39 | |||
| 40 | .. automethod:: Mastodon.status_mute | ||
| 41 | .. automethod:: Mastodon.status_unmute | ||
| 42 | |||
| 43 | .. automethod:: Mastodon.status_bookmark | ||
| 44 | .. automethod:: Mastodon.status_unbookmark | ||
| 45 | |||
| 46 | .. automethod:: Mastodon.status_delete | ||
| 47 | .. _status_update(): | ||
| 48 | .. automethod:: Mastodon.status_update | ||
| 49 | |||
| 50 | Scheduled statuses | ||
| 51 | ------------------ | ||
| 52 | These functions allow you to get information about scheduled statuses and to update scheduled statuses that already exist. | ||
| 53 | To create new scheduled statuses, use `status_post()`_ with the `scheduled_at` parameter. | ||
| 54 | |||
| 55 | Reading | ||
| 56 | ~~~~~~~ | ||
| 57 | .. automethod:: Mastodon.scheduled_statuses | ||
| 58 | .. automethod:: Mastodon.scheduled_status | ||
| 59 | |||
| 60 | Writing | ||
| 61 | ~~~~~~~ | ||
| 62 | .. automethod:: Mastodon.scheduled_status_update | ||
| 63 | .. automethod:: Mastodon.scheduled_status_delete | ||
| 64 | |||
| 65 | Media | ||
| 66 | ----- | ||
| 67 | This function allows you to upload media to Mastodon and update media uploads. | ||
| 68 | The returned media IDs (Up to 4 at the same time on a default configuration Mastodon instance) can then be used with post_status to attach media to statuses. | ||
| 69 | |||
| 70 | .. _media_post(): | ||
| 71 | .. automethod:: Mastodon.media_post | ||
| 72 | .. automethod:: Mastodon.media_update | ||
| 73 | |||
| 74 | Polls | ||
| 75 | ----- | ||
| 76 | This function allows you to get and refresh information about polls as well as to vote in polls | ||
| 77 | |||
| 78 | Reading | ||
| 79 | ~~~~~~~ | ||
| 80 | .. automethod:: Mastodon.poll | ||
| 81 | |||
| 82 | Writing | ||
| 83 | ~~~~~~~ | ||
| 84 | .. automethod:: Mastodon.poll_vote \ No newline at end of file | ||