listUsers

fun Friends.listUsers(    cursor: Long? = null,     count: Int? = null,     skipStatus: Boolean? = null,     includeUserEntities: Boolean? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorUsers, User>

Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends"). At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple "pages" of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.

Twitter API reference

Receiver

Friends endpoint instance.

Return

CursorJsonObjectApiAction for CursorUsers model.

Parameters

cursor

Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first "page." The response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.

count

The number of users to return per page, up to a maximum of 200.

skipStatus

When set to either true, t or 1 statuses will not be included in the returned user objects.

includeUserEntities

The user object entities node will not be included when set to false.

options

Optional. Custom parameters of this request.


val Friends.listUsers: CursorJsonObjectApiAction<CursorUsers, User>

Shorthand property to Friends.listUsers.

See also