Package blue.starry.penicillin.endpoints.friends

Functions

Link copied to clipboard
fun Friends.followingListByScreenName(    screenName: String,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorUsers, User>

Returns users who follows specific user.

Link copied to clipboard
fun Friends.followingListByUserId(    userId: Long,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorUsers, User>

Returns users who follows specific user.

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

Returns a cursored collection of user IDs 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 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 Friends.listIdsByScreenName(    screenName: String,     cursor: Long? = null,     stringifyIds: Boolean? = null,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorIds, Long>

Returns a cursored collection of user IDs 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 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 Friends.listIdsByUserId(    userId: Long,     cursor: Long? = null,     stringifyIds: Boolean? = null,     count: Int? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorIds, Long>

Returns a cursored collection of user IDs 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 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 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.

Link copied to clipboard
fun Friends.listUsersByScreenName(    screenName: String,     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.

Link copied to clipboard
fun Friends.listUsersByUserId(    userId: Long,     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.

Properties

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

Shorthand property to Friends.listIds.

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

Shorthand property to Friends.listUsers.