penicillin/blue.starry.penicillin.endpoints.mutes

Package blue.starry.penicillin.endpoints.mutes

Functions

fun Mutes.createByScreenName(screenName: String, vararg options: Option): JsonObjectApiAction<User>

Mutes the user specified in the ID parameter for the authenticating user. Returns the muted user when successful. Returns a string describing the failure condition when unsuccessful. Actions taken in this method are asynchronous. Changes will be eventually consistent.

createByUserId

fun Mutes.createByUserId(userId: Long, vararg options: Option): JsonObjectApiAction<User>

destroyByScreenName

fun Mutes.destroyByScreenName(screenName: String, vararg options: Option): JsonObjectApiAction<User>

Un-mutes the user specified in the ID parameter for the authenticating user. Returns the unmuted user when successful. Returns a string describing the failure condition when unsuccessful. Actions taken in this method are asynchronous. Changes will be eventually consistent.

destroyByUserId

fun Mutes.destroyByUserId(userId: Long, vararg options: Option): JsonObjectApiAction<User>

listIds

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

Returns an array of numeric user ids the authenticating user has muted.

listUsers

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

Returns an array of user objects the authenticating user has muted.

Properties

listIds

val Mutes.listIds: CursorJsonObjectApiAction<CursorIds, Long>

Shorthand property to Mutes.listIds.

listUsers

val Mutes.listUsers: CursorJsonObjectApiAction<CursorUsers, User>

Shorthand property to Mutes.listUsers.