Skip to content

ChatBotTimeoutManager

The timeout manager of the chatbot.

Extends

  • Base<T>

Type parameters

Type parameter
T extends EventSubConnection

Constructors

new ChatBotTimeoutManager()

1
new ChatBotTimeoutManager<T>(chatbot: ChatBot<T>): ChatBotTimeoutManager<T>

Creates a new instance of the timeout manager.

Parameters

ParameterTypeDescription
chatbotChatBot<T>The current instance of the chatbot.

Returns

ChatBotTimeoutManager<T>

Overrides

Base<T>.constructor

Source

twitchfy/packages/chatbot/src/structures/managers/ChatBotTimeoutManager.ts:16

Properties

PropertyModifierTypeDescriptionInherited from
chatbotreadonlyChatBot<T>The current instance of the chatbot.Base.chatbot

Methods

add()

1
add(chatroomId: string, options: TimeoutOptions): Promise<void>

Timeout a specific user.

Parameters

ParameterTypeDescription
chatroomIdstringThe id of the chatroom where the user will be sent into a timeout.
optionsTimeoutOptionsThe options required for send an user into a timeout. See Timeout.

Returns

Promise<void>

A class representation of the timeout. See Ban.

Source

twitchfy/packages/chatbot/src/structures/managers/ChatBotTimeoutManager.ts:26


delete()

1
delete(chatroomId: string, userId: string): Promise<void>

Deletes the timeout of a specific user.

Parameters

ParameterTypeDescription
chatroomIdstringThe id of the chatroom where the user will be removed from the timeout.
userIdstringThe id of the user to remove from the timeout.

Returns

Promise<void>

Source

twitchfy/packages/chatbot/src/structures/managers/ChatBotTimeoutManager.ts:36