helix/io.github.captnblubber.twitchkt.helix.model/ChatSettings

ChatSettings

@Serializable

data class ChatSettings(val broadcasterId: String, val slowMode: Boolean, val slowModeWaitTime: Int? = null, val followerMode: Boolean, val followerModeDuration: Int? = null, val subscriberMode: Boolean, val emoteMode: Boolean, val uniqueChatMode: Boolean, val nonModeratorChatDelay: Boolean = false, val nonModeratorChatDelayDuration: Int? = null, val moderatorId: String? = null)

Represents chat settings for a broadcaster's channel.

Constructors

ChatSettings

constructor(broadcasterId: String, slowMode: Boolean, slowModeWaitTime: Int? = null, followerMode: Boolean, followerModeDuration: Int? = null, subscriberMode: Boolean, emoteMode: Boolean, uniqueChatMode: Boolean, nonModeratorChatDelay: Boolean = false, nonModeratorChatDelayDuration: Int? = null, moderatorId: String? = null)

Properties

broadcasterId

@SerialName(value = "broadcaster_id")

val broadcasterId: String

the ID of the broadcaster specified in the request.

emoteMode

@SerialName(value = "emote_mode")

val emoteMode: Boolean

whether chat messages must contain only emotes.

followerMode

@SerialName(value = "follower_mode")

val followerMode: Boolean

whether the broadcaster restricts the chat room to followers only.

followerModeDuration

@SerialName(value = "follower_mode_duration")

val followerModeDuration: Int?

the length of time, in minutes, that users must follow the broadcaster before being able to participate in the chat room. null if followerMode is false.

moderatorId

@SerialName(value = "moderator_id")

val moderatorId: String?

the moderator's ID. Only included when the request specifies a user access token with the moderator:read:chat_settings scope.

nonModeratorChatDelay

@SerialName(value = "non_moderator_chat_delay")

val nonModeratorChatDelay: Boolean

whether the broadcaster adds a short delay before chat messages appear in the chat room. Only included when the request specifies a moderator access token.

nonModeratorChatDelayDuration

@SerialName(value = "non_moderator_chat_delay_duration")

val nonModeratorChatDelayDuration: Int?

the amount of time, in seconds, that messages are delayed before appearing in chat. null if nonModeratorChatDelay is false. Only included when the request specifies a moderator access token.

slowMode

@SerialName(value = "slow_mode")

val slowMode: Boolean

whether the broadcaster limits how often users in the chat room are allowed to send messages.

slowModeWaitTime

@SerialName(value = "slow_mode_wait_time")

val slowModeWaitTime: Int?

the amount of time, in seconds, that users must wait between sending messages. null if slowMode is false.

subscriberMode

@SerialName(value = "subscriber_mode")

val subscriberMode: Boolean

whether only users that subscribe to the broadcaster's channel may talk in the chat room.

uniqueChatMode

@SerialName(value = "unique_chat_mode")

val uniqueChatMode: Boolean

whether the broadcaster requires users to post only unique messages in the chat room.

ChatSettings

See also

Constructors

Properties