aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/06_accounts.rst')
-rw-r--r--docs/06_accounts.rst114
1 files changed, 114 insertions, 0 deletions
diff --git a/docs/06_accounts.rst b/docs/06_accounts.rst
new file mode 100644
index 0000000..7fe37e5
--- /dev/null
+++ b/docs/06_accounts.rst
@@ -0,0 +1,114 @@
1Accounts, relationships and lists
2=================================
3.. py:module:: mastodon
4.. py:class: Mastodon
5
6Accounts
7--------
8These functions allow you to get information about accounts and associated data as well as update that data - profile data (incuding pinned statuses and endorsements) for the logged in users account, and notes for everyone else
9
10Reading
11~~~~~~~~
12.. automethod:: Mastodon.account_verify_credentials
13.. automethod:: Mastodon.me
14
15.. automethod:: Mastodon.account
16.. automethod:: Mastodon.account_search
17.. automethod:: Mastodon.account_lookup
18
19.. automethod:: Mastodon.featured_tags
20.. automethod:: Mastodon.featured_tag_suggestions
21.. automethod:: Mastodon.account_featured_tags
22
23.. automethod:: Mastodon.endorsements
24
25.. automethod:: Mastodon.account_statuses
26.. automethod:: Mastodon.account_following
27.. automethod:: Mastodon.account_familiar_followers
28
29.. automethod:: Mastodon.account_lists
30
31Writing
32~~~~~~~
33.. automethod:: Mastodon.account_update_credentials
34
35.. automethod:: Mastodon.account_pin
36.. automethod:: Mastodon.account_unpin
37
38.. automethod:: Mastodon.account_note_set
39
40.. automethod:: Mastodon.featured_tag_create
41.. automethod:: Mastodon.featured_tag_delete
42
43.. _status_pin():
44.. automethod:: Mastodon.status_pin
45.. _status_unpin():
46.. automethod:: Mastodon.status_unpin
47
48Following and followers
49-----------------------
50These functions allow you to get information about the logged in users followers and users that the logged in users follows as well as follow requests and follow suggestions, and to
51manage that data - most importantly, follow and unfollow users.
52
53Reading
54~~~~~~~
55.. automethod:: Mastodon.account_followers
56.. automethod:: Mastodon.account_relationships
57.. automethod:: Mastodon.follows
58
59.. automethod:: Mastodon.follow_requests
60
61.. automethod:: Mastodon.suggestions
62
63Writing
64~~~~~~~
65.. _account_follow():
66.. automethod:: Mastodon.account_follow
67.. automethod:: Mastodon.account_unfollow
68
69.. automethod:: Mastodon.follow_request_authorize
70.. automethod:: Mastodon.follow_request_reject
71
72.. automethod:: Mastodon.suggestion_delete
73
74Mutes and blocks
75----------------
76These functions allow you to get information about accounts and domains that are muted or blocked by the logged in user, and to block and mute users and domains
77
78Reading
79~~~~~~~
80.. automethod:: Mastodon.mutes
81.. automethod:: Mastodon.blocks
82.. automethod:: Mastodon.domain_blocks
83
84Writing
85~~~~~~~
86.. automethod:: Mastodon.account_mute
87.. automethod:: Mastodon.account_unmute
88
89.. automethod:: Mastodon.account_block
90.. automethod:: Mastodon.account_unblock
91
92.. automethod:: Mastodon.account_remove_from_followers
93
94.. automethod:: Mastodon.domain_block
95.. automethod:: Mastodon.domain_unblock
96
97Lists
98-----
99These functions allow you to view information about lists as well as to create and update them.
100By default, the maximum number of lists for a user is 50.
101
102Reading
103~~~~~~~
104.. automethod:: Mastodon.lists
105.. automethod:: Mastodon.list
106.. automethod:: Mastodon.list_accounts
107
108Writing
109~~~~~~~
110.. automethod:: Mastodon.list_create
111.. automethod:: Mastodon.list_update
112.. automethod:: Mastodon.list_delete
113.. automethod:: Mastodon.list_accounts_add
114.. automethod:: Mastodon.list_accounts_delete
Powered by cgit v1.2.3 (git 2.41.0)