aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2017-12-13 17:11:45 +0100
committerLorenz Diener <[email protected]>2017-12-13 17:11:45 +0100
commitc06baa13b30fc5ce058940e681305f6c03dc0048 (patch)
tree5533f3cfb8e47c588383ea411ac10c560eec371f
parentd28b5725f4d239dd7baad991cff287916cc2532e (diff)
downloadmastodon.py-c06baa13b30fc5ce058940e681305f6c03dc0048.tar.gz
Update verify_credentials docs
-rw-r--r--docs/index.rst11
-rw-r--r--mastodon/Mastodon.py2
2 files changed, 11 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index dfd91ab..1d8f138 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -134,7 +134,7 @@ If you are only interested in the fact an error was raised somewhere in
134Mastodon.py, and not the details, this is the exception you can catch. 134Mastodon.py, and not the details, this is the exception you can catch.
135 135
136`MastodonIllegalArgumentError` is generally a programming problem - you asked the 136`MastodonIllegalArgumentError` is generally a programming problem - you asked the
137API to do something obviously invalid (i.e. specify a privacy scope that does 137API to do something obviously invalid (i.e. specify a privacy option that does
138not exist). 138not exist).
139 139
140`MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you 140`MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you
@@ -176,8 +176,17 @@ User dicts
176 'header': # URL for their header image, can be animated 176 'header': # URL for their header image, can be animated
177 'avatar_static': # URL for their avatar, never animated 177 'avatar_static': # URL for their avatar, never animated
178 'header_static': # URL for their header image, never animated 178 'header_static': # URL for their header image, never animated
179 'source': # Additional information - only present for user dict returned from account_verify_credentials()
179 } 180 }
180 181
182 mastodon.account_verify_credentials()["source"]
183 # Returns the following dictionary:
184 {
185 'privacy': # The users default visibility setting ("private", "unlisted" or "public")
186 'sensitive': # Denotes whether user media should be marked sensitive by default
187 'note': # Plain text version of the users bio
188 }
189
181Toot dicts 190Toot dicts
182~~~~~~~~~~ 191~~~~~~~~~~
183.. code-block:: python 192.. code-block:: python
diff --git a/mastodon/Mastodon.py b/mastodon/Mastodon.py
index 641b742..1c7b2ee 100644
--- a/mastodon/Mastodon.py
+++ b/mastodon/Mastodon.py
@@ -510,7 +510,7 @@ class Mastodon:
510 """ 510 """
511 Fetch authenticated user's account information. 511 Fetch authenticated user's account information.
512 512
513 Returns a user dict. 513 Returns a user dict (Starting from 2.1.0, with an additional "source" field).
514 """ 514 """
515 return self.__api_request('GET', '/api/v1/accounts/verify_credentials') 515 return self.__api_request('GET', '/api/v1/accounts/verify_credentials')
516 516
Powered by cgit v1.2.3 (git 2.41.0)