Document Mute Methods
authorHarmon <Harmon758@gmail.com>
Fri, 3 May 2019 05:48:28 +0000 (00:48 -0500)
committerGitHub <noreply@github.com>
Fri, 3 May 2019 05:48:28 +0000 (00:48 -0500)
Document API.create_mute, API.destroy_mute, API.mutes_ids
Resolves #1196

docs/api.rst

index 7faf6b3a9182f3a5e21e80920e88be36beec4dbf..0f5ed1ccd9d139bb4a0b3f1f71912c45c81a6bd7 100644 (file)
@@ -485,6 +485,36 @@ Block Methods
    :rtype: list of Integers
 
 
+Mute Methods
+------------
+
+.. method:: API.create_mute(id/screen_name/user_id)
+
+   Mutes the user specified in the ID parameter for the authenticating user.
+
+   :param id: |uid|
+   :param screen_name: |screen_name|
+   :param user_id: |user_id|
+   :rtype: :class:`User` object
+
+
+.. method:: API.destroy_mute(id/screen_name/user_id)
+
+   Un-mutes the user specified in the ID parameter for the authenticating user.
+
+   :param id: |uid|
+   :param screen_name: |screen_name|
+   :param user_id: |user_id|
+   :rtype: :class:`User` object
+
+
+.. method:: API.mutes_ids()
+
+   Returns an array of numeric user ids the authenticating user has muted.
+
+   :rtype: list of Integers
+
+
 Spam Reporting Methods
 ----------------------