Struct tweetust::clients::FriendshipsClient

pub struct FriendshipsClient<'a, A: 'a + Authenticator, H: 'a + HttpHandler> { /* fields omitted */ }

Provides a set of methods for the wrapper of GET/POST friendships.

Methods

impl<'a, A: Authenticator, H: HttpHandler> FriendshipsClient<'a, A, H>

pub fn no_retweets_ids(
    &self
) -> FriendshipsNoRetweetsIdsRequestBuilder<'a, A, H>

Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from. Use POST friendships/update to set the "no retweets" status for a given user account on behalf of the current user.

pub fn incoming(&self) -> FriendshipsIncomingRequestBuilder<'a, A, H>

Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.

pub fn outgoing(&self) -> FriendshipsOutgoingRequestBuilder<'a, A, H>

Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

pub fn lookup(&self) -> FriendshipsLookupRequestBuilder<'a, A, H>

Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.

pub fn show(&self) -> FriendshipsShowRequestBuilder<'a, A, H>

Returns detailed information about the relationship between two arbitrary users.

pub fn create(&self) -> FriendshipsCreateRequestBuilder<'a, A, H>

Allows the authenticating users to follow the user specified in the ID parameter. Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. Actions taken in this method are asynchronous and changes will be eventually consistent.

pub fn destroy(&self) -> FriendshipsDestroyRequestBuilder<'a, A, H>

Allows the authenticating user to unfollow the user specified in the ID parameter. Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. Actions taken in this method are asynchronous and changes will be eventually consistent.

pub fn update(&self) -> FriendshipsUpdateRequestBuilder<'a, A, H>

Allows one to enable or disable retweets and device notifications from the specified user.

Trait Implementations

impl<'a, A: Clone + 'a + Authenticator, H: Clone + 'a + HttpHandler> Clone for FriendshipsClient<'a, A, H>

fn clone(&self) -> FriendshipsClient<'a, A, H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, A: Debug + 'a + Authenticator, H: Debug + 'a + HttpHandler> Debug for FriendshipsClient<'a, A, H>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.