def hide_reply(self, id, *, user_auth=True):
"""Hides a reply to a Tweet.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
Unique identifier of the Tweet to hide. The Tweet must belong to a
conversation initiated by the authenticating user.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def unhide_reply(self, id, *, user_auth=True):
"""Unhides a reply to a Tweet.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
Unique identifier of the Tweet to unhide. The Tweet must belong to
a conversation initiated by the authenticating user.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
The request succeeds with no action when the user sends a request to a
user they're not liking the Tweet or have already unliked the Tweet.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
tweet_id : Union[int, str]
The ID of the Tweet that you would like to unlike.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
)
def get_liking_users(self, id, *, user_auth=False, **params):
- """get_liking_users(id, *, expansions, media_fields, place_fields, \
- poll_fields, tweet_fields, user_fields)
+ """get_liking_users( \
+ id, *, expansions, media_fields, place_fields, poll_fields, \
+ tweet_fields, user_fields, user_auth=False \
+ )
Allows you to get information about a Tweet’s liking users.
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_liked_tweets(self, id, *, user_auth=False, **params):
"""get_liked_tweets( \
id, *, expansions, max_results, media_fields, pagination_token, \
- place_fields, poll_fields, tweet_fields, user_fields \
+ place_fields, poll_fields, tweet_fields, user_fields, \
+ user_auth=False \
)
Allows you to get information about a user’s liked Tweets.
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def like(self, tweet_id, *, user_auth=True):
"""Like a Tweet.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
tweet_id : Union[int, str]
The ID of the Tweet that you would like to Like.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.3
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
The Tweet ID you are deleting.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.3
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
direct_message_deep_link : Optional[str]
text : Optional[str]
Text of the Tweet being created. This field is required if
``media.media_ids`` is not present.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
user they're not Retweeting the Tweet or have already removed the
Retweet of.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
source_tweet_id : Union[int, str]
The ID of the Tweet that you would like to remove the Retweet of.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
)
def get_retweeters(self, id, *, user_auth=False, **params):
- """get_retweeters(id, *, expansions, media_fields, place_fields, \
- poll_fields, tweet_fields, user_fields)
+ """get_retweeters( \
+ id, *, expansions, media_fields, place_fields, poll_fields, \
+ tweet_fields, user_fields, user_auth=False \
+ )
Allows you to get information about who has Retweeted a Tweet.
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def retweet(self, tweet_id, *, user_auth=True):
"""Causes the user ID to Retweet the target Tweet.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
tweet_id : Union[int, str]
The ID of the Tweet that you would like to Retweet.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def search_recent_tweets(self, query, *, user_auth=False, **params):
"""search_recent_tweets( \
- query, *, user_auth=False, end_time, expansions, max_results, \
- media_fields, next_token, place_fields, poll_fields, since_id, \
- start_time, tweet_fields, until_id, user_fields \
+ query, *, end_time, expansions, max_results, media_fields, \
+ next_token, place_fields, poll_fields, since_id, start_time, \
+ tweet_fields, until_id, user_fields, user_auth=False \
)
The recent search endpoint returns Tweets from the last seven days that
include it.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_users_mentions(self, id, *, user_auth=False, **params):
"""get_users_mentions( \
- id, *, user_auth=False, end_time, expansions, max_results, \
- media_fields, pagination_token, place_fields, poll_fields, \
- since_id, start_time, tweet_fields, until_id, user_fields \
+ id, *, end_time, expansions, max_results, media_fields, \
+ pagination_token, place_fields, poll_fields, since_id, \
+ start_time, tweet_fields, until_id, user_fields, user_auth=False \
)
Returns Tweets mentioning a single user specified by the requested user
Unique identifier of the user for whom to return Tweets mentioning
the user. User ID can be referenced using the `user/lookup`_
endpoint. More information on Twitter IDs is `here`_.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The new UTC timestamp
from which the Tweets will be provided. Timestamp is in second
Twitter IDs is `here`_.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_users_tweets(self, id, *, user_auth=False, **params):
"""get_users_tweets( \
- id, *, user_auth=False, end_time, exclude, expansions, \
- max_results, media_fields, pagination_token, place_fields, \
- poll_fields, since_id, start_time, tweet_fields, until_id, \
- user_fields \
+ id, *, end_time, exclude, expansions, max_results, media_fields, \
+ pagination_token, place_fields, poll_fields, since_id, \
+ start_time, tweet_fields, until_id, user_fields, user_auth=False \
)
Returns Tweets composed by a single user, specified by the requested
Unique identifier of the Twitter account (user ID) for whom to
return results. User ID can be referenced using the `user/lookup`_
endpoint. More information on Twitter IDs is `here`_.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The newest or most recent
UTC timestamp from which the Tweets will be provided. Only the 3200
``until_id`` will be forced to the most recent ID available.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
# Tweet lookup
def get_tweet(self, id, *, user_auth=False, **params):
- """get_tweet(id, *, user_auth=False, expansions, media_fields, \
- place_fields, poll_fields, twitter_fields, user_fields)
+ """get_tweet(id, *, expansions, media_fields, place_fields, \
+ poll_fields, twitter_fields, user_fields, user_auth=False)
Returns a variety of information about a single Tweet specified by
the requested ID.
----------
id : Union[int, str]
Unique identifier of the Tweet to request
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
media_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
)
def get_tweets(self, ids, *, user_auth=False, **params):
- """get_tweets(ids, *, user_auth=False, expansions, media_fields, \
- place_fields, poll_fields, twitter_fields, user_fields)
+ """get_tweets( \
+ ids, *, expansions, media_fields, place_fields, poll_fields, \
+ twitter_fields, user_fields, user_auth=False \
+ )
Returns a variety of information about the Tweet specified by the
requested ID or list of IDs.
A comma separated list of Tweet IDs. Up to 100 are allowed in a
single request. Make sure to not include a space between commas and
fields.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
media_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
The request succeeds with no action when the user sends a request to a
user they're not blocking or have already unblocked.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
target_user_id : Union[int, str]
The user ID of the user that you would like to unblock.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_blocked(self, *, user_auth=True, **params):
"""get_blocked(*, expansions, max_results, pagination_token, \
- tweet_fields, user_fields)
+ tweet_fields, user_fields, user_auth=True)
Returns a list of users who are blocked by the authenticating user.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
expansions : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def block(self, target_user_id, *, user_auth=True):
"""Block another user.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
target_user_id : Union[int, str]
The user ID of the user that you would like to block.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionchanged:: 4.2
Renamed from :meth:`Client.unfollow`
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
target_user_id : Union[int, str]
The user ID of the user that you would like to unfollow.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_users_followers(self, id, *, user_auth=False, **params):
"""get_users_followers( \
- id, *, user_auth=False, expansions, max_results, \
- pagination_token, tweet_fields, user_fields \
+ id, *, expansions, max_results, pagination_token, tweet_fields, \
+ user_fields, user_auth=False \
)
Returns a list of users who are followers of the specified user ID.
----------
id : Union[int, str]
The user ID whose followers you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_users_following(self, id, *, user_auth=False, **params):
"""get_users_following( \
- id, *, user_auth=False, expansions, max_results, \
- pagination_token, tweet_fields, user_fields \
+ id, *, expansions, max_results, pagination_token, tweet_fields, \
+ user_fields, user_auth=False \
)
Returns a list of users the specified user ID is following.
----------
id : Union[int, str]
The user ID whose following you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionchanged:: 4.2
Renamed from :meth:`Client.follow`
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
target_user_id : Union[int, str]
The user ID of the user that you would like to follow.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
The request succeeds with no action when the user sends a request to a
user they're not muting or have already unmuted.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
target_user_id : Union[int, str]
The user ID of the user that you would like to unmute.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_muted(self, *, user_auth=True, **params):
"""get_muted(*, expansions, max_results, pagination_token, \
- tweet_fields, user_fields)
+ tweet_fields, user_fields, user_auth=True)
Returns a list of users who are muted by the authenticating user.
.. versionadded:: 4.1
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
expansions : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def mute(self, target_user_id, *, user_auth=True):
"""Allows an authenticated user ID to mute the target user.
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
target_user_id : Union[int, str]
The user ID of the user that you would like to mute.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
# User lookup
def get_user(self, *, id=None, username=None, user_auth=False, **params):
- """get_user(*, id, username, user_auth=False, expansions, \
- tweet_fields, user_fields)
+ """get_user(*, id, username, expansions, tweet_fields, user_fields, \
+ user_auth=False)
Returns a variety of information about a single user specified by the
requested ID or username.
The ID of the user to lookup.
username : str
The Twitter username (handle) of the user.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Raises
------
def get_users(self, *, ids=None, usernames=None, user_auth=False,
**params):
- """get_users(*, ids, usernames, user_auth=False, expansions, \
- tweet_fields, user_fields)
+ """get_users(*, ids, usernames, expansions, tweet_fields, \
+ user_fields, user_auth=False)
Returns a variety of information about one or more users specified by
the requested IDs or usernames.
A comma separated list of Twitter usernames (handles). Up to 100
are allowed in a single request. Make sure to not include a space
between commas and fields.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Raises
------
)
def get_me(self, *, user_auth=True, **params):
- """get_me(*, expansions, tweet_fields, user_fields)
+ """get_me(*, expansions, tweet_fields, user_fields, user_auth=True)
Returns information about an authorized user.
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
# List Tweets lookup
def get_list_tweets(self, id, *, user_auth=False, **params):
- """get_list_tweets(id, *, user_auth=False, expansions, max_results, \
- pagination_token, tweet_fields, user_fields)
+ """get_list_tweets(id, *, expansions, max_results, pagination_token, \
+ tweet_fields, user_fields, user_auth=False)
Returns a list of Tweets from the specified List.
----------
id : Union[List[str], str]
The ID of the List whose Tweets you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
list_id : Union[int, str]
The ID of the List that you would like the user to unfollow.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_list_followers(self, id, *, user_auth=False, **params):
"""get_list_followers( \
- id, *, user_auth=False, expansions, max_results, \
- pagination_token, tweet_fields, user_fields \
+ id, *, expansions, max_results, pagination_token, tweet_fields, \
+ user_fields, user_auth=False \
)
Returns a list of users who are followers of the specified List.
----------
id : Union[List[str], str]
The ID of the List whose followers you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_followed_lists(self, id, *, user_auth=False, **params):
"""get_followed_lists( \
- id, *, user_auth=False, expansions, list_fields, max_results, \
- pagination_token, user_fields \
+ id, *, expansions, list_fields, max_results, pagination_token, \
+ user_fields, user_auth=False \
)
Returns all Lists a specified user follows.
----------
id : Union[List[str], str]
The user ID whose followed Lists you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
list_fields : Union[List[str], str]
previous_token returned in your previous response.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
list_id : Union[int, str]
The ID of the List that you would like the user to follow.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
# List lookup
def get_list(self, id, *, user_auth=False, **params):
- """get_list(id, *, user_auth=False, expansions, list_fields, \
- user_fields)
+ """get_list(id, *, expansions, list_fields, user_fields, \
+ user_auth=False)
Returns the details of a specified List.
----------
id : Union[List[str], str]
The ID of the List to lookup.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
list_fields : Union[List[str], str]
:ref:`list_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
)
def get_owned_lists(self, id, *, user_auth=False, **params):
- """get_owned_lists(id, *, user_auth=False, expansions, list_fields, \
- max_results, pagination_token, user_fields)
+ """get_owned_lists(id, *, expansions, list_fields, max_results, \
+ pagination_token, user_fields, user_auth=False)
Returns all Lists owned by the specified user.
----------
id : Union[List[str], str]
The user ID whose owned Lists you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
list_fields : Union[List[str], str]
previous_token returned in your previous response.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
The ID of the List you are removing a member from.
user_id : Union[int, str]
The ID of the user you wish to remove as a member of the List.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
)
def get_list_members(self, id, *, user_auth=False, **params):
- """get_list_members(id, *, user_auth=False, expansions, max_results, \
- pagination_token, tweet_fields, user_fields)
+ """get_list_members(id, *, expansions, max_results, pagination_token, \
+ tweet_fields, user_fields, user_auth=False)
Returns a list of users who are members of the specified List.
----------
id : Union[List[str], str]
The ID of the List whose members you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
def get_list_memberships(self, id, *, user_auth=False, **params):
"""get_list_memberships( \
- id, *, user_auth=False, expansions, list_fields, max_results, \
- pagination_token, user_fields \
+ id, *, expansions, list_fields, max_results, pagination_token, \
+ user_fields, user_auth=False \
)
Returns all Lists a specified user is a member of.
----------
id : Union[List[str], str]
The user ID whose List memberships you would like to retrieve.
- user_auth : bool
- Whether or not to use OAuth 1.0a User context
expansions : Union[List[str], str]
:ref:`expansions_parameter`
list_fields : Union[List[str], str]
previous_token returned in your previous response.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
The ID of the List you are adding a member to.
user_id : Union[int, str]
The ID of the user you wish to add as a member of the List.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
The ID of the List to be deleted.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
id : Union[int, str]
Updates the name of the List.
private : bool
Determines whether the List should be private.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
name : str
Description of the List.
private : bool
Determine whether the List should be private.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
list_id : Union[int, str]
The ID of the List that you would like the user to unpin.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
)
def get_pinned_lists(self, *, user_auth=True, **params):
- """get_pinned_lists(*, expansions, list_fields, user_fields)
+ """get_pinned_lists(*, expansions, list_fields, user_fields, \
+ user_auth=True)
Returns the Lists pinned by a specified user.
.. versionadded:: 4.4
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
expansions : Union[List[str], str]
:ref:`list_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
.. versionadded:: 4.2
+ .. versionchanged:: 4.5
+ Added ``user_auth`` parameter
+
Parameters
----------
list_id : Union[int, str]
The ID of the List that you would like the user to pin.
+ user_auth : bool
+ Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
projects / tweepy.git / commitdiff