helix/io.github.captnblubber.twitchkt.helix.resource/UserResource

UserResource

class UserResource

Twitch Helix Users API resource.

Provides methods for getting and updating user information, managing block lists, and working with user extensions.

See also

Twitch API Reference - Users

Functions

suspend fun blockUser(targetUserId: String, sourceContext: BlockSourceContext? = null, reason: BlockReason? = null)

Twitch API: Block User

getActiveExtensions

suspend fun getActiveExtensions(userId: String? = null): ActiveExtensions

Twitch API: Get User Active Extensions

getAllBlockedUsers

fun getAllBlockedUsers(broadcasterId: String): Flow<BlockedUser>

Twitch API: Get User Block List

suspend fun getBlockList(broadcasterId: String, cursor: String? = null, pageSize: Int? = null): Page<BlockedUser>

Twitch API: Get User Block List

suspend fun getExtensions(): List<UserExtension>

Twitch API: Get User Extensions

suspend fun getUsers(ids: List<String> = emptyList(), logins: List<String> = emptyList()): List<User>

Twitch API: Get Users

suspend fun unblockUser(targetUserId: String)

Twitch API: Unblock User

updateActiveExtensions

suspend fun updateActiveExtensions(extensions: ActiveExtensions): ActiveExtensions

Twitch API: Update User Extensions

suspend fun updateUser(description: String? = null): User

Twitch API: Update User