org.apache.streams.twitter.api

Interface Friendships

@Remoteable(path="https://api.twitter.com/1.1/friendships")
public interface Friendships

Interface for /friendships methods.

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/overview

Method Summary

Modifier and Type	Method and Description
User	create(FriendshipCreateRequest parameters) Allows the authenticating users to follow the user specified in the ID parameter.
User	destroy(FriendshipDestroyRequest parameters) Allows the authenticating user to unfollow the user specified in the ID parameter.
User	incoming(FriendshipsIncomingRequest parameters) Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.
List<Friendship>	lookup(FriendshipsLookupRequest parameters) Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided.
User	outgoing(FriendshipsOutgoingRequest parameters) Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
FriendshipShowResponse	show(FriendshipShowRequest parameters) Returns detailed information about the relationship between two arbitrary users.
User	update(FriendshipUpdateRequest parameters) Allows one to enable or disable retweets and device notifications from the specified user.

Method Detail

create

@RemoteMethod(httpMethod="POST",
              path="/create.json")
User create(@QueryIfNE(value="*")
                                                                                FriendshipCreateRequest parameters)

Allows the authenticating users to follow the user specified in the ID parameter.

Parameters:

parameters - FriendshipCreateRequest

Returns:

User

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create

destroy

@RemoteMethod(httpMethod="POST",
              path="/destroy.json")
User destroy(@QueryIfNE(value="*")
                                                                                  FriendshipDestroyRequest parameters)

Allows the authenticating user to unfollow the user specified in the ID parameter.

Parameters:

parameters - FriendshipDestroyRequest

Returns:

User

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy

incoming

@RemoteMethod(httpMethod="GET",
              path="/incoming.json")
User incoming(@QueryIfNE(value="*")
                                                                                   FriendshipsIncomingRequest parameters)

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

Parameters:

parameters - FriendshipsIncomingRequest

Returns:

FollowersListResponse

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming

lookup

@RemoteMethod(httpMethod="GET",
              path="/lookup.json")
List<Friendship> lookup(@QueryIfNE(value="*")
                                                                                           FriendshipsLookupRequest parameters)

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, blocking, muting.

Parameters:

parameters - FriendshipsLookupRequest

Returns:

List[Friendship]

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup

outgoing

@RemoteMethod(httpMethod="GET",
              path="/outgoing.json")
User outgoing(@QueryIfNE(value="*")
                                                                                   FriendshipsOutgoingRequest parameters)

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

Parameters:

parameters - FriendshipsOutgoingRequest

Returns:

FollowersListResponse

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming

show

@RemoteMethod(httpMethod="GET",
              path="/show.json")
FriendshipShowResponse show(@QueryIfNE(value="*")
                                                                                             FriendshipShowRequest parameters)

Returns detailed information about the relationship between two arbitrary users.

Parameters:

parameters - FriendshipShowRequest

Returns:

FriendshipShowResponse

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show

update

@RemoteMethod(httpMethod="GET",
              path="/update.json")
User update(@QueryIfNE(value="*")
                                                                               FriendshipUpdateRequest parameters)

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

Parameters:

parameters - FriendshipUpdateRequest

Returns:

User

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update