penicillin/blue.starry.penicillin.endpoints/Followers

Followers

class Followers(val client: ApiClient) : Endpoint
Content copied to clipboard

Collection of api endpoints related to followers.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun Followers(client: ApiClient)
Content copied to clipboard

Creates new Followers endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient
Content copied to clipboard

Extensions

Link copied to clipboard
val Followers.listIds: CursorJsonObjectApiAction<CursorIds, Long>
Content copied to clipboard

Shorthand property to Followers.listIds.

fun Followers.listIds(    cursor: Long? = null,     stringifyIds: Boolean? = null,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorIds, Long>
Content copied to clipboard

Returns a cursored collection of user IDs for every user following the specified user. 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 5,000 user IDs 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. This method is especially powerful when used in conjunction with GET users/lookup, a method that allows you to convert user IDs into full user objects in bulk.

Link copied to clipboard
fun Followers.listIdsByScreenName(    screenName: String,     cursor: Long? = null,     stringifyIds: Boolean? = null,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorIds, Long>
Content copied to clipboard

Returns a cursored collection of user IDs for every user following the specified user. 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 5,000 user IDs 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. This method is especially powerful when used in conjunction with GET users/lookup, a method that allows you to convert user IDs into full user objects in bulk.

Link copied to clipboard
fun Followers.listIdsByUserId(    userId: Long,     cursor: Long? = null,     stringifyIds: Boolean? = null,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorIds, Long>
Content copied to clipboard

Returns a cursored collection of user IDs for every user following the specified user. 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 5,000 user IDs 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. This method is especially powerful when used in conjunction with GET users/lookup, a method that allows you to convert user IDs into full user objects in bulk.

Link copied to clipboard
val Followers.listUsers: CursorJsonObjectApiAction<CursorUsers, User>
Content copied to clipboard

Shorthand property to Followers.listUsers.

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

Returns a cursored collection of user objects for users following the specified user. 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.

Link copied to clipboard
fun Followers.listUsersByScreenName(    screenName: String,     cursor: Long? = null,     count: Int? = null,     skipStatus: Boolean? = null,     includeUserEntities: Boolean? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorUsers, User>
Content copied to clipboard

Returns a cursored collection of user objects for users following the specified user. 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.

Link copied to clipboard
fun Followers.listUsersByUserId(    userId: Long,     cursor: Long? = null,     count: Int? = null,     skipStatus: Boolean? = null,     includeUserEntities: Boolean? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorUsers, User>
Content copied to clipboard

Returns a cursored collection of user objects for users following the specified user. 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.