Package com.twitter.clientlib.api

Class UsersApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.UsersApi

public class UsersApi
extends ApiCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UsersApi.APIfindMyUserRequest
class	UsersApi.APIfindUserByIdRequest
class	UsersApi.APIfindUserByUsernameRequest
class	UsersApi.APIfindUsersByIdRequest
class	UsersApi.APIfindUsersByUsernameRequest
class	UsersApi.APIlistGetFollowersRequest
class	UsersApi.APIlistGetMembersRequest
class	UsersApi.APItweetsIdLikingUsersRequest
class	UsersApi.APItweetsIdRetweetingUsersRequest
class	UsersApi.APIusersIdBlockingRequest
class	UsersApi.APIusersIdBlockRequest
class	UsersApi.APIusersIdFollowersRequest
class	UsersApi.APIusersIdFollowingRequest
class	UsersApi.APIusersIdFollowRequest
class	UsersApi.APIusersIdMuteRequest
class	UsersApi.APIusersIdMutingRequest
class	UsersApi.APIusersIdUnblockRequest
class	UsersApi.APIusersIdUnfollowRequest
class	UsersApi.APIusersIdUnmuteRequest

Field Summary

Fields inherited from class com.twitter.clientlib.api.ApiCommon

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
UsersApi()

Method Summary

Modifier and Type	Method	Description
UsersApi.APIfindMyUserRequest	findMyUser()	User lookup me This endpoint returns information about the requesting User.
UsersApi.APIfindUserByIdRequest	findUserById(String id)	User lookup by ID This endpoint returns information about a User.
UsersApi.APIfindUserByUsernameRequest	findUserByUsername(String username)	User lookup by username This endpoint returns information about a User.
UsersApi.APIfindUsersByIdRequest	findUsersById(List<String> ids)	User lookup by IDs This endpoint returns information about Users.
UsersApi.APIfindUsersByUsernameRequest	findUsersByUsername(List<String> usernames)	User lookup by usernames This endpoint returns information about Users.
UsersApi.APIlistGetFollowersRequest	listGetFollowers(String id)	Returns User objects that follow a List by the provided List ID Returns a list of Users that follow a List by the provided List ID
UsersApi.APIlistGetMembersRequest	listGetMembers(String id)	Returns User objects that are members of a List by the provided List ID.
UsersApi.APItweetsIdLikingUsersRequest	tweetsIdLikingUsers(String id)	Returns User objects that have liked the provided Tweet ID Returns a list of Users that have liked the provided Tweet ID
UsersApi.APItweetsIdRetweetingUsersRequest	tweetsIdRetweetingUsers(String id)	Returns User objects that have retweeted the provided Tweet ID Returns a list of Users that have retweeted the provided Tweet ID
UsersApi.APIusersIdBlockRequest	usersIdBlock(BlockUserRequest blockUserRequest, String id)	Block User by User ID Causes the User (in the path) to block the target User.
UsersApi.APIusersIdBlockingRequest	usersIdBlocking(String id)	Returns User objects that are blocked by provided User ID Returns a list of Users that are blocked by the provided User ID
UsersApi.APIusersIdFollowRequest	usersIdFollow(String id)	Follow User Causes the User(in the path) to follow, or “request to follow” for protected Users, the target User.
UsersApi.APIusersIdFollowersRequest	usersIdFollowers(String id)	Followers by User ID Returns a list of Users who are followers of the specified User ID.
UsersApi.APIusersIdFollowingRequest	usersIdFollowing(String id)	Following by User ID Returns a list of Users that are being followed by the provided User ID
UsersApi.APIusersIdMuteRequest	usersIdMute(String id)	Mute User by User ID.
UsersApi.APIusersIdMutingRequest	usersIdMuting(String id)	Returns User objects that are muted by the provided User ID Returns a list of Users that are muted by the provided User ID
UsersApi.APIusersIdUnblockRequest	usersIdUnblock(String sourceUserId, String targetUserId)	Unblock User by User ID Causes the source User to unblock the target User.
UsersApi.APIusersIdUnfollowRequest	usersIdUnfollow(String sourceUserId, String targetUserId)	Unfollow User Causes the source User to unfollow the target User.
UsersApi.APIusersIdUnmuteRequest	usersIdUnmute(String sourceUserId, String targetUserId)	Unmute User by User ID Causes the source User to unmute the target User.

Methods inherited from class com.twitter.clientlib.api.ApiCommon

handleRateLimit, reduceAuthNames, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersApi

public UsersApi()

Method Detail

findMyUser

public UsersApi.APIfindMyUserRequest findMyUser()

User lookup me This endpoint returns information about the requesting User.

Returns:

APIfindMyUserRequest

See Also:

User lookup me Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

findUserById

public UsersApi.APIfindUserByIdRequest findUserById(String id)

User lookup by ID This endpoint returns information about a User. Specify User by ID.

Parameters:

id - The ID of the User to lookup. (required)

Returns:

APIfindUserByIdRequest

See Also:

User lookup by ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

findUserByUsername

public UsersApi.APIfindUserByUsernameRequest findUserByUsername(String username)

User lookup by username This endpoint returns information about a User. Specify User by username.

Parameters:

username - A username. (required)

Returns:

APIfindUserByUsernameRequest

See Also:

User lookup by username Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

findUsersById

public UsersApi.APIfindUsersByIdRequest findUsersById(List<String> ids)

User lookup by IDs This endpoint returns information about Users. Specify Users by their ID.

Parameters:

ids - A list of User IDs, comma-separated. You can specify up to 100 IDs. (required)

Returns:

APIfindUsersByIdRequest

See Also:

User lookup by IDs Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

findUsersByUsername

public UsersApi.APIfindUsersByUsernameRequest findUsersByUsername(List<String> usernames)

User lookup by usernames This endpoint returns information about Users. Specify Users by their username.

Parameters:

usernames - A list of usernames, comma-separated. (required)

Returns:

APIfindUsersByUsernameRequest

See Also:

User lookup by usernames Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listGetFollowers

public UsersApi.APIlistGetFollowersRequest listGetFollowers(String id)

Returns User objects that follow a List by the provided List ID Returns a list of Users that follow a List by the provided List ID

Parameters:

id - The ID of the List. (required)

Returns:

APIlistGetFollowersRequest

See Also:

Returns User objects that follow a List by the provided List ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listGetMembers

public UsersApi.APIlistGetMembersRequest listGetMembers(String id)

Returns User objects that are members of a List by the provided List ID. Returns a list of Users that are members of a List by the provided List ID.

Parameters:

id - The ID of the List. (required)

Returns:

APIlistGetMembersRequest

See Also:

Returns User objects that are members of a List by the provided List ID. Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

tweetsIdLikingUsers

public UsersApi.APItweetsIdLikingUsersRequest tweetsIdLikingUsers(String id)

Returns User objects that have liked the provided Tweet ID Returns a list of Users that have liked the provided Tweet ID

Parameters:

id - A single Tweet ID. (required)

Returns:

APItweetsIdLikingUsersRequest

See Also:

Returns User objects that have liked the provided Tweet ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

tweetsIdRetweetingUsers

public UsersApi.APItweetsIdRetweetingUsersRequest tweetsIdRetweetingUsers(String id)

Returns User objects that have retweeted the provided Tweet ID Returns a list of Users that have retweeted the provided Tweet ID

Parameters:

id - A single Tweet ID. (required)

Returns:

APItweetsIdRetweetingUsersRequest

See Also:

Returns User objects that have retweeted the provided Tweet ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdBlock

public UsersApi.APIusersIdBlockRequest usersIdBlock(BlockUserRequest blockUserRequest,
                                                    String id)

Block User by User ID Causes the User (in the path) to block the target User. The User (in the path) must match the User context authorizing the request

Parameters:

blockUserRequest - (required)

id - The ID of the authenticated source User that is requesting to block the target User. (required)

Returns:

APIusersIdBlockRequest

See Also:

Block User by User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdBlocking

public UsersApi.APIusersIdBlockingRequest usersIdBlocking(String id)

Returns User objects that are blocked by provided User ID Returns a list of Users that are blocked by the provided User ID

Parameters:

id - The ID of the authenticated source User for whom to return results. (required)

Returns:

APIusersIdBlockingRequest

See Also:

Returns User objects that are blocked by provided User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdFollow

public UsersApi.APIusersIdFollowRequest usersIdFollow(String id)

Follow User Causes the User(in the path) to follow, or “request to follow” for protected Users, the target User. The User(in the path) must match the User context authorizing the request

Parameters:

id - The ID of the authenticated source User that is requesting to follow the target User. (required)

Returns:

APIusersIdFollowRequest

See Also:

Follow User Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdFollowers

public UsersApi.APIusersIdFollowersRequest usersIdFollowers(String id)

Followers by User ID Returns a list of Users who are followers of the specified User ID.

Parameters:

id - The ID of the User to lookup. (required)

Returns:

APIusersIdFollowersRequest

See Also:

Followers by User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdFollowing

public UsersApi.APIusersIdFollowingRequest usersIdFollowing(String id)

Following by User ID Returns a list of Users that are being followed by the provided User ID

Parameters:

id - The ID of the User to lookup. (required)

Returns:

APIusersIdFollowingRequest

See Also:

Following by User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdMute

public UsersApi.APIusersIdMuteRequest usersIdMute(String id)

Mute User by User ID. Causes the User (in the path) to mute the target User. The User (in the path) must match the User context authorizing the request.

Parameters:

id - The ID of the authenticated source User that is requesting to mute the target User. (required)

Returns:

APIusersIdMuteRequest

See Also:

Mute User by User ID. Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdMuting

public UsersApi.APIusersIdMutingRequest usersIdMuting(String id)

Returns User objects that are muted by the provided User ID Returns a list of Users that are muted by the provided User ID

Parameters:

id - The ID of the authenticated source User for whom to return results. (required)

Returns:

APIusersIdMutingRequest

See Also:

Returns User objects that are muted by the provided User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdUnblock

public UsersApi.APIusersIdUnblockRequest usersIdUnblock(String sourceUserId,
                                                        String targetUserId)

Unblock User by User ID Causes the source User to unblock the target User. The source User must match the User context authorizing the request

Parameters:

sourceUserId - The ID of the authenticated source User that is requesting to unblock the target User. (required)

targetUserId - The ID of the User that the source User is requesting to unblock. (required)

Returns:

APIusersIdUnblockRequest

See Also:

Unblock User by User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdUnfollow

public UsersApi.APIusersIdUnfollowRequest usersIdUnfollow(String sourceUserId,
                                                          String targetUserId)

Unfollow User Causes the source User to unfollow the target User. The source User must match the User context authorizing the request

Parameters:

sourceUserId - The ID of the authenticated source User that is requesting to unfollow the target User. (required)

targetUserId - The ID of the User that the source User is requesting to unfollow. (required)

Returns:

APIusersIdUnfollowRequest

See Also:

Unfollow User Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdUnmute

public UsersApi.APIusersIdUnmuteRequest usersIdUnmute(String sourceUserId,
                                                      String targetUserId)

Unmute User by User ID Causes the source User to unmute the target User. The source User must match the User context authorizing the request

Parameters:

sourceUserId - The ID of the authenticated source User that is requesting to unmute the target User. (required)

targetUserId - The ID of the User that the source User is requesting to unmute. (required)

Returns:

APIusersIdUnmuteRequest

See Also:

Unmute User by User ID Documentation

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-