penicillin/blue.starry.penicillin.endpoints/Mutes

Mutes

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

Collection of api endpoints related to mutes.

See also

Parameters

client

Current ApiClient instance.

Constructors

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

Creates new Mutes endpoint instance.

Properties

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

Extensions

Link copied to clipboard
fun Mutes.createByScreenName(screenName: String, vararg options: Option): JsonObjectApiAction<User>
Content copied to clipboard

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.

Link copied to clipboard
fun Mutes.createByUserId(userId: Long, vararg options: Option): JsonObjectApiAction<User>
Content copied to clipboard

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.

Link copied to clipboard
fun Mutes.destroyByScreenName(screenName: String, vararg options: Option): JsonObjectApiAction<User>
Content copied to clipboard

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.

Link copied to clipboard
fun Mutes.destroyByUserId(userId: Long, vararg options: Option): JsonObjectApiAction<User>
Content copied to clipboard

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.

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

Shorthand property to Mutes.listIds.

fun Mutes.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 has muted.

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

Shorthand property to Mutes.listUsers.

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

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