Skip to content

Commit

Permalink
Add documentation for API.mutes
Browse files Browse the repository at this point in the history
  • Loading branch information
Harmon758 committed May 10, 2019
1 parent 97b6401 commit 29bae1f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/api.rst
Expand Up @@ -509,6 +509,16 @@ Mute Methods
:rtype: :class:`User` object


.. method:: API.mutes([cursor], [include_entities], [skip_status])

Returns an array of user objects the authenticating user has muted.

:param cursor: |cursor|
:param include_entities: |include_entities|
:param skip_status: |skip_status|
:rtype: list of :class:`User` objects


.. method:: API.mutes_ids([cursor])

Returns an array of numeric user ids the authenticating user has muted.
Expand Down
1 change: 1 addition & 0 deletions docs/parameters.rst
Expand Up @@ -5,6 +5,7 @@
.. |date| replace:: Permits specifying a start date for the report. The date should be formatted YYYY-MM-DD.
.. |exclude| replace:: Setting this equal to hashtags will remove all hashtags from the trends list.
.. |full_text| replace:: A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.
.. |include_entities| replace:: The entities node will not be included when set to false. Defaults to true.
.. |include_user_entities| replace:: The user object entities node will not be included when set to false. Defaults to true.
.. |list_id| replace:: The numerical id of the list.
.. |list_mode| replace:: Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.
Expand Down

0 comments on commit 29bae1f

Please sign in to comment.