penicillin/blue.starry.penicillin.endpoints.blocks

Package blue.starry.penicillin.endpoints.blocks

Functions

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

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.

createByUserId

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

destroyByScreenName

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

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.

destroyByUserId

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

listIds

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

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

listUsers

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

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

Properties

listIds

val Blocks.listIds: CursorJsonObjectApiAction<CursorIds, Long>

Shorthand extension property to Blocks.listIds.

listUsers

val Blocks.listUsers: CursorJsonObjectApiAction<CursorUsers, User>

Shorthand extension property to Blocks.listUsers.