From 3ee80ccd245f32154d0a232e2abadd56aab948fc Mon Sep 17 00:00:00 2001 From: Kumar Appaiah Date: Tue, 8 Dec 2009 16:15:33 -0600 Subject: [PATCH] Complete formatting of API documentation. Signed-off-by: Joshua Roesslein --- doc/api.rst | 688 ++++++++++++++++++++++++++-------------------------- 1 file changed, 346 insertions(+), 342 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 907a8b9..6c9a6ef 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -11,491 +11,495 @@ This page contains some basic documentation for the Tweepy module. .. class:: API([auth_handler], [host], [search_host], [cache], [secure], [api_root], [search_root], [retry_count], [retry_delay], [retry_errors]) -Document this class. + This class provides a wrapper for the API as provided by + Twitter. The functions provided in this class are listed below. Timeline methods ---------------- -.. method:: API.public_timeline +.. method:: API.public_timeline() -Returns the 20 most recent statuses from non-protected users who have -set a custom user icon. The public timeline is cached for 60 seconds -so requesting it more often than that is a waste of resources. + Returns the 20 most recent statuses from non-protected users who have + set a custom user icon. The public timeline is cached for 60 seconds + so requesting it more often than that is a waste of resources. -Parameters: None + Parameters: None -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.home_timeline +.. method:: API.home_timeline([since_id], [max_id], [count], [page]) -Returns the 20 most recent statuses, including retweets, posted by the -authenticating user and that user's friends. This is the equivalent of -/timeline/home on the Web. + Returns the 20 most recent statuses, including retweets, posted by the + authenticating user and that user's friends. This is the equivalent of + /timeline/home on the Web. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.friends_timeline +.. method:: API.friends_timeline([since_id], [max_id], [count], [page]) -Returns the 20 most recent statuses posted by the authenticating user -and that user's friends. + Returns the 20 most recent statuses posted by the authenticating user + and that user's friends. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.user_timeline +.. method:: API.user_timeline([id/user_id/screen_name], [since_id], [max_id], [count], [page]) -Returns the 20 most recent statuses posted from the authenticating -user. It's also possible to request another user's timeline via the id -parameter. + Returns the 20 most recent statuses posted from the authenticating + user. It's also possible to request another user's timeline via the id + parameter. -Parameters: (id or user_id or screen_name), since_id, max_id, count, page + Parameters: *id* or *user_id* or *screen_name*, *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.mentions +.. method:: API.mentions([since_id], [max_id], [count], [page]) -Returns the 20 most recent mentions (status containing @username) for -the authenticating user. + Returns the 20 most recent mentions (status containing @username) for + the authenticating user. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.retweeted_by_me +.. method:: API.retweeted_by_me([since_id], [max_id], [count], [page]) -Returns the 20 most recent retweets posted by the authenticating user. + Returns the 20 most recent retweets posted by the authenticating user. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.retweeted_to_me +.. method:: API.retweeted_to_me([since_id], [max_id], [count], [page]) -Returns the 20 most recent retweets posted by the authenticating -user's friends. + Returns the 20 most recent retweets posted by the authenticating + user's friends. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects .. method:: API.retweets_of_me -Returns the 20 most recent tweets of the authenticated user that have -been retweeted by others. + Returns the 20 most recent tweets of the authenticated user that have + been retweeted by others. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects Status methods -------------- -.. method:: API.get_status +.. method:: API.get_status(id) Returns a single status specified by the ID parameter. -Parameters: id (Required) +Parameters: *id* (Required) Returns: class:`Status` object -.. method:: API.update_status +.. method:: API.update_status(status, [in_reply_to_status_id], [lat], [long]) -Update the authenticated user's status. Statuses that are duplicates -or too long will be silently ignored. + Update the authenticated user's status. Statuses that are duplicates + or too long will be silently ignored. -Parameters: status (Required), in_reply_to_status_id, lat, long + Parameters: *status* (Required), *in_reply_to_status_id*, *lat*, *long* -Returns: class:`Status` object + Returns: class:`Status` object -.. method:: API.destroy_status +.. method:: API.destroy_status(id) -Destroy the status specified by the id parameter. The authenticated -user must be the author of the status to destroy. + Destroy the status specified by the id parameter. The authenticated + user must be the author of the status to destroy. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: class:`Status` object + Returns: class:`Status` object -.. method:: API.retweet +.. method:: API.retweet(id) -Retweets a tweet. Requires the id of the tweet you are retweeting. + Retweets a tweet. Requires the id of the tweet you are retweeting. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: class:`Status` object + Returns: class:`Status` object -.. method:: API.retweets +.. method:: API.retweets(id) -Returns up to 100 of the first retweets of the given tweet. + Returns up to 100 of the first retweets of the given tweet. -Parameters: id (Required), count + Parameters: *id* (Required), count -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects User methods ------------ -.. method:: API.get_user +.. method:: API.get_user(id) -Returns information about the specified user. + Returns information about the specified user. -Parameters: id OR screen_name OR id (One of these is Required) + Parameters: *id* OR screen_name OR id (One of these is Required) -Returns: User object + Returns: class:`User` object -.. method:: API.me +.. method:: API.me() -Returns the authenticated user's information. + Returns the authenticated user's information. -Parameters: None + Parameters: None -Returns: User object -friends + Returns: User object -Returns an user's friends ordered in which they were added 100 at a time. If no user is specified by id/screen name, it defaults to the authenticated user. +.. method::API.friends([id/screen_name/user_id], [cursor]) -Parameters: id OR screen_name OR user_id, cursor + Returns an user's friends ordered in which they were added 100 at a time. If no user is specified by id/screen name, it defaults to the authenticated user. -Returns: list of User objects + Parameters: *id* OR *screen_name* OR *user_id*, *cursor* + Returns: list of class:`User` objects -.. method:: API.followers -Returns an user's followers ordered in which they were added 100 at a -time. If no user is specified by id/screen name, it defaults to the -authenticated user. +.. method:: API.followers([id/screen_name/user_id], [cursor]) -Parameters: id OR screen_name OR user_id, cursor + Returns an user's followers ordered in which they were added 100 at a + time. If no user is specified by id/screen name, it defaults to the + authenticated user. -Returns: list of User objects + Parameters: *id* OR *screen_name* OR *user_id*, *cursor* + Returns: list of User objects -.. method:: API.search_users -Run a search for users similar to Find People button on Twitter.com; -the same results returned by people search on Twitter.com will be -returned by using this API (about being listed in the People -Search). It is only possible to retrieve the first 1000 matches from -this API. +.. method:: API.search_users(q, [per_page], [page]) -Parameters: q (Required. The query.), per_page, page + Run a search for users similar to Find People button on Twitter.com; + the same results returned by people search on Twitter.com will be + returned by using this API (about being listed in the People + Search). It is only possible to retrieve the first 1000 matches from + this API. -Returns: list of User objects + Parameters: *q* (Required. The query.), *per_page*, *page* + + Returns: list of class:`User` objects Direct Message Methods ---------------------- -.. method:: API.direct_messages +.. method:: API.direct_messages([since_id], [max_id], [count], [page]) -Returns direct messages sent to the authenticating user. + Returns direct messages sent to the authenticating user. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of DirectMessage objects + Returns: list of DirectMessage objects -.. method:: API.sent_direct_messages +.. method:: API.sent_direct_messages([since_id], [max_id], [count], [page]) -Returns direct messages sent by the authenticating user. + Returns direct messages sent by the authenticating user. -Parameters: since_id, max_id, count, page + Parameters: *since_id*, *max_id*, *count*, *page* -Returns: list of DirectMessage objects + Returns: list of DirectMessage objects -.. method:: API.send_direct_message +.. method:: API.send_direct_message(user, text) -Sends a new direct message to the specified user from the -authenticating user. + Sends a new direct message to the specified user from the + authenticating user. -Parameters: user (Required), text (Required) + Parameters: *user* (Required), *text* (Required) -Returns: DirectMessage object + Returns: class:`DirectMessage` object -.. method:: API.destroy_direct_message +.. method:: API.destroy_direct_message(id) -Destroy a direct message. Authenticating user must be the recipient of -the direct message. + Destroy a direct message. Authenticating user must be the recipient of + the direct message. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: DirectMessage object + Returns: class:`DirectMessage` object -.. method:: API.create_friendship +Friendship Methods +------------------ -Create a new friendship with the specified user (aka follow). +.. method:: API.create_friendship(id/screen_name/user_id) -Parameters: id OR screen_name OR user_id (One of these is required) + Create a new friendship with the specified user (aka follow). -Returns: User object + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) + Returns: User object -.. method:: API.destroy_friendship -Destroy a friendship with the specified user (aka unfollow). +.. method:: API.destroy_friendship(id/screen_name/user_id) -Parameters: id OR screen_name OR user_id (One of these is required) + Destroy a friendship with the specified user (aka unfollow). -Returns: User object + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) + Returns: User object -.. method:: API.exists_friendship -Checks if a friendship exists between two users. Will return True if -user_a follows user_b, otherwise False. +.. method:: API.exists_friendship(user_a, user_b) -Parameters: user_a (Required), user_b (Required) + Checks if a friendship exists between two users. Will return True if + user_a follows user_b, otherwise False. -Returns: True/False + Parameters: *user_a* (Required), *user_b* (Required) + Returns: True/False -.. method:: API.show_friendship -Returns detailed information about the relationship between two users. +.. method:: API.show_friendship(id/screen_name/user_id, target_id/target_screen_name) -Parameters: source_id OR source_screen_name (One of these is required), target_id OR target_screen_name (One of these is required) + Returns detailed information about the relationship between two users. -Returns: Friendship object + Parameters: *id* OR *screen_name* OR *user_id* (One of these is + required), *target_id* OR *target_screen_name* (One of these is + required) + Returns: Friendship object -Friendship Methods ------------------- -.. method:: API.friends_ids +.. method:: API.friends_ids(id/screen_name/user_id) -Returns an array containing the IDs of users being followed by the -specified user. + Returns an array containing the IDs of users being followed by the + specified user. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: list of Integers + Returns: list of Integers -.. method:: API.followers_ids +.. method:: API.followers_ids(id/screen_name/user_id) -Returns an array containing the IDs of users following the specified -user. + Returns an array containing the IDs of users following the specified + user. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR screen_name OR user_id (One of these is required) -Returns: list of Integers + Returns: list of Integers Account Methods --------------- -.. method:: API.verify_credentials +.. method:: API.verify_credentials() -Verify the supplied user credentials are valid. + Verify the supplied user credentials are valid. -Parameters: None + Parameters: None -Returns: User object if credentials are valid, otherwise False + Returns: class:`User` object if credentials are valid, otherwise False -.. method:: API.rate_limit_status +.. method:: API.rate_limit_status() -Returns the remaining number of API requests available to the -requesting user before the API limit is reached for the current -hour. Calls to rate_limit_status do not count against the rate -limit. If authentication credentials are provided, the rate limit -status for the authenticating user is returned. Otherwise, the rate -limit status for the requester's IP address is returned. + Returns the remaining number of API requests available to the + requesting user before the API limit is reached for the current + hour. Calls to rate_limit_status do not count against the rate + limit. If authentication credentials are provided, the rate limit + status for the authenticating user is returned. Otherwise, the rate + limit status for the requester's IP address is returned. -Parameters: None + Parameters: None -Returns: JSON object + Returns: class:`JSON` object -.. method:: API.set_delivery_device +.. method:: API.set_delivery_device(device) -Sets which device Twitter delivers updates to for the authenticating -user. Sending "none" as the device parameter will disable SMS updates. + Sets which device Twitter delivers updates to for the authenticating + user. Sending "none" as the device parameter will disable SMS updates. -Parameters: device (Required. Valid values: sms OR none) + Parameters: *device* (Required. Valid values: sms OR none) -Returns: User object + Returns: class:`User` object -.. method:: API.update_profile_colors +.. method:: API.update_profile_colors([profile_background_color], [profile_text_color], [profile_link_color], [profile_sidebar_fill_color], [profile_sidebar_border_color]) -Sets one or more hex values that control the color scheme of the -authenticating user's profile page on twitter.com. + Sets one or more hex values that control the color scheme of the + authenticating user's profile page on twitter.com. -Parameters: profile_background_color, profile_text_color, profile_link_color, profile_sidebar_fill_color, profile_sidebar_border_color + Parameters: *profile_background_color*, *profile_text_color*, *profile_link_color*, *profile_sidebar_fill_color*, *profile_sidebar_border_color* -Returns: User object + Returns: class:`User` object -.. method:: API.update_profile_image +.. method:: API.update_profile_image(filename) -Update the authenticating user's profile image. Valid formats: GIF, -JPG, or PNG + Update the authenticating user's profile image. Valid formats: GIF, + JPG, or PNG -Parameters: filename (Path to image file. Required) + Parameters: filename (Path to image file. Required) -Returns: User object + Returns: class:`User` object -.. method:: API.update_profile_background_image +.. method:: API.update_profile_background_image(filename) -Update authenticating user's background image. Valid formats: GIF, -JPG, or PNG + Update authenticating user's background image. Valid formats: GIF, + JPG, or PNG -Parameters: filename (Path to image file. Required), tile + Parameters: filename (Path to image file. Required), tile -Returns: User object + Returns: class:`User` object -.. method:: API.update_profile +.. method:: API.update_profile([name], [url], [location], [description]) -Sets values that users are able to set under the "Account" tab of -their settings page. + Sets values that users are able to set under the "Account" tab of + their settings page. -Parameters: name, url, location, description + Parameters: *name*, *url*, *location*, *description* -Returns: User object + Returns: class:`User` object Favorite Methods ---------------- -.. method:: API.favorites +.. method:: API.favorites([id], [page]) -Returns the favorite statuses for the authenticating user or user -specified by the ID parameter. + Returns the favorite statuses for the authenticating user or user + specified by the ID parameter. -Parameters: id, page + Parameters: *id*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.create_favorite +.. method:: API.create_favorite(id) -Favorites the status specified in the ID parameter as the -authenticating user. + Favorites the status specified in the ID parameter as the + authenticating user. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: class:`Status` object + Returns: class:`Status` object -.. method:: API.destroy_favorite +.. method:: API.destroy_favorite(id) -Un-favorites the status specified in the ID parameter as the -authenticating user. + Un-favorites the status specified in the ID parameter as the + authenticating user. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: class:`Status` object + Returns: class:`Status` object Notification Methods -------------------- -.. method:: API.enable_notifications +.. method:: API.enable_notifications(id/screen_name/user_id) -Enables device notifications for updates from the specified user. + Enables device notifications for updates from the specified user. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: User object + Returns: class:`User` object -.. method:: API.disable_notifications +.. method:: API.disable_notifications(id/screen_name/user_id) -Disables notifications for updates from the specified user to the -authenticating user. + Disables notifications for updates from the specified user to the + authenticating user. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: User object + Returns: class:`User` object Block Methods ------------- -.. method:: API.create_block +.. method:: API.create_block(id/screen_name/user_id) -Blocks the user specified in the ID parameter as the authenticating -user. Destroys a friendship to the blocked user if it exists. + Blocks the user specified in the ID parameter as the authenticating + user. Destroys a friendship to the blocked user if it exists. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: User object + Returns: class:`User` object -.. method:: API.destroy_block +.. method:: API.destroy_block(id/screen_name/user_id) -Un-blocks the user specified in the ID parameter for the -authenticating user. + Un-blocks the user specified in the ID parameter for the + authenticating user. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: User object + Returns: class:`User` object -.. method:: API.exists_block +.. method:: API.exists_block(id/screen_name/user_id) -Checks if the authenticated user is blocking the specified user. + Checks if the authenticated user is blocking the specified user. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: True/False + Returns: True/False -.. method:: API.blocks +.. method:: API.blocks([page]) -Returns an array of user objects that the authenticating user is -blocking. + Returns an array of user objects that the authenticating user is + blocking. -Parameters: page + Parameters: page -Returns: list of User objects + Returns: list of class:`User` objects .. method:: API.blocks_ids -Returns an array of numeric user ids the authenticating user is -blocking. + Returns an array of numeric user ids the authenticating user is + blocking. -Parameters: None + Parameters: None -Returns: list of Integers + Returns: list of Integers Spam Reporting Methods ---------------------- -.. method:: API.report_spam +.. method:: API.report_spam([id/user_id/screen_name]) -The user specified in the id is blocked by the authenticated user and -reported as a spammer. + The user specified in the id is blocked by the authenticated user and + reported as a spammer. -Parameters: id OR screen_name OR user_id (One of these is required) + Parameters: *id* OR *screen_name* OR *user_id* (One of these is required) -Returns: User object + Returns: class:`User` object Saved Searches Methods @@ -503,254 +507,254 @@ Saved Searches Methods .. method:: API.saved_searches -Returns the authenticated user's saved search queries. + Returns the authenticated user's saved search queries. -Parameters: None + Parameters: None -Returns: list of SavedSearch objects + Returns: list of class:`SavedSearch` objects -.. method:: API.get_saved_search +.. method:: API.get_saved_search(id) -Retrieve the data for a saved search owned by the authenticating user -specified by the given id. + Retrieve the data for a saved search owned by the authenticating user + specified by the given id. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: SavedSearch object + Returns: class:`SavedSearch` object -.. method:: API.create_saved_search +.. method:: API.create_saved_search(query) -Creates a saved search for the authenticated user. + Creates a saved search for the authenticated user. -Parameters: query (Required) + Parameters: *query* (Required) -Returns: SavedSearch object + Returns: class:`SavedSearch` object -.. method:: API.destroy_saved_search +.. method:: API.destroy_saved_search(id) -Destroys a saved search for the authenticated user. The search -specified by id must be owned by the authenticating user. + Destroys a saved search for the authenticated user. The search + specified by id must be owned by the authenticating user. -Parameters: id (Required) + Parameters: *id* (Required) -Returns: SavedSearch object + Returns: class:`SavedSearch` object Help Methods ------------ -.. method:: API.test +.. method:: API.test() -Invokes the test method in the Twitter API. Return True if successful, -otherwise False. + Invokes the test method in the Twitter API. Return True if successful, + otherwise False. -Parameters: None + Parameters: None -Returns: True/False + Returns: True/False -.. method:: API.search +.. method:: API.search() -Returns tweets that match a specified query. + Returns tweets that match a specified query. -Parameters: q (Required. The search query string.), lang, locale, rpp, page, since_id, geocode, show_user + Parameters: q (Required. The search query string.), lang, locale, rpp, page, since_id, geocode, show_user -Returns: list of SearchResult objects + Returns: list of class:`SearchResult` objects -.. method:: API.trends +.. method:: API.trends() -Returns the top ten topics that are currently trending on Twitter. The -response includes the time of the request, the name of each trend, and -the url to the Twitter Search results page for that topic. + Returns the top ten topics that are currently trending on Twitter. The + response includes the time of the request, the name of each trend, and + the url to the Twitter Search results page for that topic. -Parameters: None + Parameters: None -Returns: JSON object + Returns: class:`JSON` object -.. method:: API.trends_current +.. method:: API.trends_current([exclude]) -Returns the current top 10 trending topics on Twitter. The response -includes the time of the request, the name of each trending topic, and -query used on Twitter Search results page for that topic. + Returns the current top 10 trending topics on Twitter. The response + includes the time of the request, the name of each trending topic, and + query used on Twitter Search results page for that topic. -Parameters: exclude + Parameters: *exclude* -Returns: JSON object + Returns: class:`JSON` object -.. method:: API.trends_daily +.. method:: API.trends_daily([date], [exclude]) -Returns the top 20 trending topics for each hour in a given day. + Returns the top 20 trending topics for each hour in a given day. -Parameters: date, exclude + Parameters: *date*, *exclude* -Returns: JSON object + Returns: class:`JSON` object -.. method:: API.trends_weekly +.. method:: API.trends_weekly([date], [exclude]) -Returns the top 30 trending topics for each day in a given week. + Returns the top 30 trending topics for each day in a given week. -Parameters: date, exclude + Parameters: *date*, *exclude* -Returns: JSON object + Returns: class:`JSON` object List Methods ------------ -.. method:: API.create_list +.. method:: API.create_list(name, [mode]) -Creates a new list for the authenticated user. Accounts are limited to -20 lists. + Creates a new list for the authenticated user. Accounts are limited to + 20 lists. -Parameters: name (Required), mode (public/private default: public) + Parameters: *name* (Required), *mode* (public/private default: public) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.destroy_list +.. method:: API.destroy_list(slug) -Deletes the specified list. Must be owned by the authenticated user. + Deletes the specified list. Must be owned by the authenticated user. -Parameters: slug (Required. May also be the list ID.) + Parameters: *slug* (Required. May also be the list ID.) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.update_list +.. method:: API.update_list(slug, [name], [mode]) -Updates the specified list. Note: this current throws a 500. Twitter -is looking into the issue. + Updates the specified list. Note: this current throws a 500. Twitter + is looking into the issue. -Parameters: slug (Required. May also be the list ID.), name, mode (public/private) + Parameters: *slug* (Required. May also be the list ID.), *name*, *mode* (public/private) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.lists +.. method:: API.lists([cursor]) -List the lists of the specified user. Private lists will be included -if the authenticated users is the same as the user who's lists are -being returned. + List the lists of the specified user. Private lists will be included + if the authenticated users is the same as the user who's lists are + being returned. -Parameters: cursor + Parameters: *cursor* -Returns: list of class:`List` objects + Returns: list of class:`List` objects -.. method:: API.lists_memberships +.. method:: API.lists_memberships([cursor]) -List the lists the specified user has been added to. + List the lists the specified user has been added to. -Parameters: cursor + Parameters: *cursor* -Returns: list of class:`List` objects + Returns: list of class:`List` objects -.. method:: API.lists_subscriptions +.. method:: API.lists_subscriptions([cursor]) -List the lists the specified user follows. + List the lists the specified user follows. -Parameters: cursor + Parameters: *cursor* -Returns: list of class:`List` objects + Returns: list of class:`List` objects -.. method:: API.list_timeline +.. method:: API.list_timeline(owner, slug, [since_id], [max_id], [count], [page]) -Show tweet timeline for members of the specified list. + Show tweet timeline for members of the specified list. -Parameters: owner (Required.), slug (Required. May also be the list ID.), since_id, max_id, count, page + Parameters: *owner* (Required.), *slug* (Required. May also be the list ID.), *since_id*, *max_id*, *count*, *page* -Returns: list of class:`Status` objects + Returns: list of class:`Status` objects -.. method:: API.get_list +.. method:: API.get_list(owner, slug) -Show the specified list. Private lists will only be shown if the -authenticated user owns the specified list. + Show the specified list. Private lists will only be shown if the + authenticated user owns the specified list. -Parameters: owner (Required.), slug (Required. May also be the list ID.) + Parameters: *owner* (Required.), *slug* (Required. May also be the list ID.) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.add_list_member +.. method:: API.add_list_member*slug, id) -Add a member to a list. The authenticated user must own the list to be -able to add members to it. Lists are limited to having 500 members. + Add a member to a list. The authenticated user must own the list to be + able to add members to it. Lists are limited to having 500 members. -Parameters: slug (Required. May also be the list ID.), id (Required. ID of user to add.) + Parameters: *slug* (Required. May also be the list ID.), *id* (Required. ID of user to add.) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.remove_list_member +.. method:: API.remove_list_member(slug, id) -Removes the specified member from the list. The authenticated user -must be the list's owner to remove members from the list. + Removes the specified member from the list. The authenticated user + must be the list's owner to remove members from the list. -Parameters: slug (Required. May also be the list ID.), id (Required. ID of user to remove.) + Parameters: *slug* (Required. May also be the list ID.), *id* (Required. ID of user to remove.) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.list_members +.. method:: API.list_members(owner, slug, cursor) -Returns the members of the specified list. + Returns the members of the specified list. -Parameters: owner (Required.), slug (Required. May also be list ID.), cursor + Parameters: *owner* (Required.), *slug* (Required. May also be list ID.), *cursor* -Returns: list of User objects + Returns: list of class:`User` objects -.. method:: API.is_list_member +.. method:: API.is_list_member(owner, slug, id) -Check if a user is a member of the specified list. + Check if a user is a member of the specified list. -Parameters: owner (Required.), slug (Required. May also be list ID.), id (Required. User to check if is a member on the list or not.) + Parameters: *owner* (Required.), *slug* (Required. May also be list ID.), *id* (Required. class:`User` to check if subscribed to the list.) -Returns: User object if user is a member of list, otherwise False. + Returns: class:`User` object if user is a member of list, otherwise False. -.. method:: API.subscribe_list +.. method:: API.subscribe_list(owner, slug) -Make the authenticated user follow the specified list. + Make the authenticated user follow the specified list. -Parameters: owner (Required.), slug (Required. May also be list ID.) + Parameters: *owner* (Required.), *slug* (Required. May also be list ID.) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.unsubscribe_list +.. method:: API.unsubscribe_list(owner, slug) -Unsubscribes the authenticated user form the specified list. + Unsubscribes the authenticated user form the specified list. -Parameters: owner (Required.), slug (Required. May also be list ID.) + Parameters: *owner* (Required.), *slug* (Required. May also be list ID.) -Returns: class:`List` object + Returns: class:`List` object -.. method:: API.list_subscribers +.. method:: API.list_subscribers(owner, slug, [cursor]) -Returns the subscribers of the specified list. + Returns the subscribers of the specified list. -Parameters: owner (Required.), slug (Required. May also be list ID.), cursor + Parameters: *owner* (Required.), *slug* (Required. May also be list ID.), *cursor* -Returns: list of User objects + Returns: list of class:`User` objects -.. method:: API.is_subscribed_list +.. method:: API.is_subscribed_list(owner, slug, id) -Check if the specified user is a subscriber of the specified list. + Check if the specified user is a subscriber of the specified list. -Parameters: owner (Required.), slug (Required. May also be list ID.), id (Required. User to check if subscribed to the list.) + Parameters: *owner* (Required.), *slug* (Required. May also be list ID.), *id* (Required. class:`User` to check if subscribed to the list.) -Returns: User object if user is subscribed to the list, otherwise False. + Returns: class:`User` object if user is subscribed to the list, otherwise False. -- 2.25.1