Users

class Users(val client: ApiClient) : Endpoint

Collection of api endpoints related to other users.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun Users(client: ApiClient)

Creates new Users endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient

Extensions

Link copied to clipboard
fun Users.extendedProfile(    screenName: String,     includeBirthdate: Boolean? = null,     vararg options: Option): JsonObjectApiAction<ExtendedProfile>

Undocumented endpoint.

Link copied to clipboard
fun Users.lookupByIds(    userIds: List<Long>,     includeEntities: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     vararg options: Option): JsonArrayApiAction<User>

Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters. This method is especially useful when used in conjunction with collections of user IDs returned from GET friends / ids and GET followers / ids. GET users / show is used to retrieve a single user object. There are a few things to note when using this method.

Link copied to clipboard
fun Users.lookupByScreenNames(    screenNames: List<String>,     includeEntities: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     vararg options: Option): JsonArrayApiAction<User>

Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters. This method is especially useful when used in conjunction with collections of user IDs returned from GET friends / ids and GET followers / ids. GET users / show is used to retrieve a single user object. There are a few things to note when using this method.

Link copied to clipboard
fun Users.profileBannerByScreenName(screenName: String, vararg options: Option): JsonObjectApiAction<UserProfileBanner>

Returns a map of the available size variations of the specified user's profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in Profile Images and Banners.

Link copied to clipboard
fun Users.profileBannerByUserId(userId: Long, vararg options: Option): JsonObjectApiAction<UserProfileBanner>

Returns a map of the available size variations of the specified user's profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in Profile Images and Banners.

Link copied to clipboard
fun Users.recommendationsByScreenName(screenName: String, vararg options: Option): JsonArrayApiAction<Recommendation>

Undocumented endpoint.

Link copied to clipboard
fun Users.recommendationsByUserId(userId: Long, vararg options: Option): JsonArrayApiAction<Recommendation>

Undocumented endpoint.

Link copied to clipboard
fun Users.reportSpamByScreenName(    screenName: String,     performBlock: Boolean? = null,     vararg options: Option): JsonObjectApiAction<User>

Report the specified user as a spam account to Twitter. Additionally, optionally performs the equivalent of POST blocks/create on behalf of the authenticated user.

Link copied to clipboard
fun Users.reportSpamByUserId(    userId: Long,     performBlock: Boolean? = null,     vararg options: Option): JsonObjectApiAction<User>

Report the specified user as a spam account to Twitter. Additionally, optionally performs the equivalent of POST blocks/create on behalf of the authenticated user.

Link copied to clipboard
fun Users.search(    query: String,     page: Int? = null,     count: Int? = null,     includeEntities: Boolean? = null,     vararg options: Option): JsonArrayApiAction<User>

Provides a simple, relevance-based search interface to public user accounts on Twitter. Try querying by topical interest, full name, company name, location, or other criteria. Exact match searches are not supported. Only the first 1,000 matching results are available.

Link copied to clipboard
fun Users.showByScreenName(    screenName: String,     includeEntities: Boolean? = null,     vararg options: Option): JsonObjectApiAction<User>

Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author's most recent Tweet will be returned inline when possible. GET users/lookup is used to retrieve a bulk collection of user objects. You must be following a protected user to be able to see their most recent Tweet. If you don't follow a protected user, the user's Tweet will be removed. A Tweet will not always be returned in the current_status field.

Link copied to clipboard
fun Users.showByUserId(    userId: Long,     includeEntities: Boolean? = null,     vararg options: Option): JsonObjectApiAction<User>

Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author's most recent Tweet will be returned inline when possible. GET users/lookup is used to retrieve a bulk collection of user objects. You must be following a protected user to be able to see their most recent Tweet. If you don't follow a protected user, the user's Tweet will be removed. A Tweet will not always be returned in the current_status field.

Link copied to clipboard

Shorthand property to Users.userSuggestionCategories.

fun Users.userSuggestionCategories(lang: String? = null, vararg options: Option): JsonArrayApiAction<UserSuggestionCategory>

Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in GET users / suggestions/:slug to get the users in that category.

Link copied to clipboard
fun Users.userSuggestionMembers(slug: String, vararg options: Option): JsonArrayApiAction<User>

Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.

Link copied to clipboard
fun Users.userSuggestions(    slug: String,     lang: String? = null,     vararg options: Option): JsonObjectApiAction<UserSuggestion>

Access the users in a given category of the Twitter suggested user list. It is recommended that applications cache this data for no more than one hour.