penicillin/blue.starry.penicillin.endpoints/Blocks

Blocks

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

Collection of api endpoints related to blocks.

See also

Parameters

client

Current ApiClient instance.

Constructors

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

Creates new Blocks endpoint instance.

Properties

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

Extensions

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

Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.

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

Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.

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

Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user when successful. If relationships existed before the block was instantiated, they will not be restored.

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

Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user when successful. If relationships existed before the block was instantiated, they will not be restored.

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

Shorthand extension property to Blocks.listIds.

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

Returns an array of numeric user ids the authenticating user is blocking.

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

Shorthand extension property to Blocks.listUsers.

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

Returns a collection of user objects that the authenticating user is blocking.