diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst index b9fcde1..ef94b2a 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -263,12 +263,13 @@ User dicts | |||
263 | 'header_static': # URL for their header image, never animated | 263 | 'header_static': # URL for their header image, never animated |
264 | 'source': # Additional information - only present for user dict returned | 264 | 'source': # Additional information - only present for user dict returned |
265 | # from account_verify_credentials() | 265 | # from account_verify_credentials() |
266 | 'moved_to_account': # If set, an account dict of the account this user has | 266 | 'moved_to_account': # If set, a user dict of the account this user has |
267 | # set up as their moved-to address. | 267 | # set up as their moved-to address. |
268 | 'bot': # Boolean indicating whether this account is automated. | 268 | 'bot': # Boolean indicating whether this account is automated. |
269 | 'fields': # List of up to four dicts with free-form 'name' and 'value' profile info. | 269 | 'fields': # List of up to four dicts with free-form 'name' and 'value' profile info. |
270 | # For fields with "this is me" type verification, verified_at is set to the | 270 | # For fields with "this is me" type verification, verified_at is set to the |
271 | # last verification date (It is None otherwise) | 271 | # last verification date (It is None otherwise) |
272 | 'emojis': # List of custom emoji used in name, bio or fields | ||
272 | } | 273 | } |
273 | 274 | ||
274 | mastodon.account_verify_credentials()["source"] | 275 | mastodon.account_verify_credentials()["source"] |
@@ -626,7 +627,7 @@ Search result dicts | |||
626 | mastodon.search("<query>") | 627 | mastodon.search("<query>") |
627 | # Returns the following dictionary | 628 | # Returns the following dictionary |
628 | { | 629 | { |
629 | 'accounts': # List of account dicts resulting from the query | 630 | 'accounts': # List of user dicts resulting from the query |
630 | 'hashtags': # List of hashtag dicts resulting from the query | 631 | 'hashtags': # List of hashtag dicts resulting from the query |
631 | 'statuses': # List of toot dicts resulting from the query | 632 | 'statuses': # List of toot dicts resulting from the query |
632 | } | 633 | } |
@@ -651,7 +652,7 @@ Instance dicts | |||
651 | 'stats: # A dictionary containing three stats, user_count (number of local users), | 652 | 'stats: # A dictionary containing three stats, user_count (number of local users), |
652 | # status_count (number of local statuses) and domain_count (number of known | 653 | # status_count (number of local statuses) and domain_count (number of known |
653 | # instance domains other than this one). | 654 | # instance domains other than this one). |
654 | 'contact_account': # Account dict of the primary contact for the instance | 655 | 'contact_account': # User dict of the primary contact for the instance |
655 | 'languages': # Array of ISO 639-1 (two-letter) language codes the instance | 656 | 'languages': # Array of ISO 639-1 (two-letter) language codes the instance |
656 | # has chosen to advertise. | 657 | # has chosen to advertise. |
657 | 'registrations': # Boolean indication whether registrations on this instance are open | 658 | 'registrations': # Boolean indication whether registrations on this instance are open |
@@ -691,11 +692,11 @@ Report dicts | |||
691 | 'comment': # Text comment submitted with the report | 692 | 'comment': # Text comment submitted with the report |
692 | 'created_at': # Time at which this report was created, as a datetime object | 693 | 'created_at': # Time at which this report was created, as a datetime object |
693 | 'updated_at': # Last time this report has been updated, as a datetime object | 694 | 'updated_at': # Last time this report has been updated, as a datetime object |
694 | 'account': # Account dict of the user that filed this report | 695 | 'account': # User dict of the user that filed this report |
695 | 'target_account': # Account that has been reported with this report | 696 | 'target_account': # Account that has been reported with this report |
696 | 'assigned_account': # If the report as been assigned to an account, | 697 | 'assigned_account': # If the report as been assigned to an account, |
697 | # account dict of that account (None if not) | 698 | # User dict of that account (None if not) |
698 | 'action_taken_by_account': # Account dict of the account that processed this report | 699 | 'action_taken_by_account': # User dict of the account that processed this report |
699 | 'statuses': # List of statuses attached to the report, as toot dicts | 700 | 'statuses': # List of statuses attached to the report, as toot dicts |
700 | } | 701 | } |
701 | 702 | ||
@@ -796,7 +797,7 @@ Admin account dicts | |||
796 | 'locale': # For local users, the locale the user has set, | 797 | 'locale': # For local users, the locale the user has set, |
797 | 'invite_request': # If the user requested an invite, the invite request comment of that user. (TODO permanent?) | 798 | 'invite_request': # If the user requested an invite, the invite request comment of that user. (TODO permanent?) |
798 | 'invited_by_account_id': # Present if the user was invited by another user and set to the inviting users id. | 799 | 'invited_by_account_id': # Present if the user was invited by another user and set to the inviting users id. |
799 | 'account': # The users account, as a standard account dict | 800 | 'account': # The users account, as a standard user dict |
800 | } | 801 | } |
801 | 802 | ||
802 | App registration and user authentication | 803 | App registration and user authentication |
@@ -942,6 +943,11 @@ Reading data: Follow suggestions | |||
942 | 943 | ||
943 | .. automethod:: Mastodon.suggestions | 944 | .. automethod:: Mastodon.suggestions |
944 | 945 | ||
946 | Reading data: Profile directory | ||
947 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
948 | |||
949 | .. authomethod:: Mastodon.directory | ||
950 | |||
945 | Reading data: Lists | 951 | Reading data: Lists |
946 | ------------------- | 952 | ------------------- |
947 | These functions allow you to view information about lists. | 953 | These functions allow you to view information about lists. |