Package com.github.twitch4j.helix.domain

Class ChatSettings.ChatSettingsBuilder

java.lang.Object
com.github.twitch4j.helix.domain.ChatSettings.ChatSettingsBuilder
Enclosing class:
ChatSettings
public static class ChatSettings.ChatSettingsBuilder extends Object

  • Method Details

    • broadcasterId

      public ChatSettings.ChatSettingsBuilder broadcasterId(String broadcasterId)
      The ID of the broadcaster specified in the request.
      Returns:
      this.

    • isEmoteOnlyMode

      public ChatSettings.ChatSettingsBuilder isEmoteOnlyMode(Boolean isEmoteOnlyMode)
      A Boolean value that determines whether chat messages must contain only emotes. Is true, if only messages that are 100% emotes are allowed; otherwise, false.
      Returns:
      this.

    • isFollowersOnlyMode

      public ChatSettings.ChatSettingsBuilder isFollowersOnlyMode(Boolean isFollowersOnlyMode)
      A Boolean value that determines whether the broadcaster restricts the chat room to followers only, based on how long they’ve followed. Is true, if the broadcaster restricts the chat room to followers only; otherwise, false.
      Returns:
      this.
      See Also:

    • followerModeDuration

      public ChatSettings.ChatSettingsBuilder followerModeDuration(@Nullable @Nullable Integer followerModeDuration)
      The length of time, in minutes, that the followers must have followed the broadcaster to participate in the chat room Is null if follower_mode is false.

      When setting this through the API, the possible values range from 0 (all followers) to 129600 (3 months). The default is 0.

      Returns:
      this.
      See Also:

    • moderatorId

      public ChatSettings.ChatSettingsBuilder moderatorId(@Nullable @Nullable String moderatorId)
      The moderator’s ID. The response includes this field only if the request specifies a User access token that includes the moderator:read:chat_settings scope.
      Returns:
      this.
      See Also:

    • hasNonModeratorChatDelay

      public ChatSettings.ChatSettingsBuilder hasNonModeratorChatDelay(@Nullable @Nullable Boolean hasNonModeratorChatDelay)
      A Boolean value that determines whether the broadcaster adds a short delay before chat messages appear in the chat room. This gives chat moderators and bots a chance to remove them before viewers can see the message.

      Is true, if the broadcaster applies a delay; otherwise, false.

      The response includes this field only if the request specifies a User access token that includes the moderator:read:chat_settings scope.

      Returns:
      this.
      See Also:

    • nonModeratorChatDelayDuration

      public ChatSettings.ChatSettingsBuilder nonModeratorChatDelayDuration(@Nullable @Nullable Integer nonModeratorChatDelayDuration)
      The amount of time, in seconds, that messages are delayed from appearing in chat.

      Is null if non_moderator_chat_delay is false.

      The response includes this field only if the request specifies a User access token that includes the moderator:read:chat_settings scope.

      When setting this through the API, the possible values are:

      • 2 — 2 second delay (recommended)
      • 4 — 4 second delay
      • 6 — 6 second delay
      Returns:
      this.
      See Also:

    • isSlowMode

      public ChatSettings.ChatSettingsBuilder isSlowMode(Boolean isSlowMode)
      A Boolean value that determines whether the broadcaster limits how often users in the chat room are allowed to send messages.

      Is true, if the broadcaster applies a delay; otherwise, false.

      Returns:
      this.
      See Also:

    • slowModeWaitTime

      public ChatSettings.ChatSettingsBuilder slowModeWaitTime(@Nullable @Nullable Integer slowModeWaitTime)
      The amount of time, in seconds, that users need to wait between sending messages.

      Is null if slow_mode is false.

      When setting this through the API, the possible values range from 3 (three-second delay) to 120 (two-minute delay). The default is 30 seconds.

      Returns:
      this.
      See Also:

    • isSubscribersOnlyMode

      public ChatSettings.ChatSettingsBuilder isSubscribersOnlyMode(Boolean isSubscribersOnlyMode)
      A Boolean value that determines whether only users that subscribe to the broadcaster’s channel can talk in the chat room.

      Is true, if the broadcaster restricts the chat room to subscribers only; otherwise, false.

      Returns:
      this.

    • isUniqueChatMode

      public ChatSettings.ChatSettingsBuilder isUniqueChatMode(Boolean isUniqueChatMode)
      A Boolean value that determines whether the broadcaster requires users to post only unique messages in the chat room.

      Is true, if the broadcaster requires unique messages only; otherwise, false.

      Returns:
      this.

    • build

      public ChatSettings build()

    • toString

      public String toString()
      Overrides:
      toString in class Object