From 5186ba7bc4c5e766429dc1f9ff1251f6e8c8308a Mon Sep 17 00:00:00 2001 From: Harmon Date: Fri, 3 May 2019 00:48:28 -0500 Subject: [PATCH] Document Mute Methods Document API.create_mute, API.destroy_mute, API.mutes_ids Resolves #1196 --- docs/api.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index 7faf6b3..0f5ed1c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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 ---------------------- -- 2.25.1