ChatBotTimeoutManager
The timeout manager of the chatbot.
Extends
Base
<T
>
Type parameters
Type parameter |
---|
T extends EventSubConnection |
Constructors
new ChatBotTimeoutManager()
Creates a new instance of the timeout manager.
Parameters
Parameter | Type | Description |
---|---|---|
chatbot | ChatBot <T > | The current instance of the chatbot. |
Returns
Overrides
Base<T>.constructor
Source
twitchfy/packages/chatbot/src/structures/managers/ChatBotTimeoutManager.ts:16
Properties
Property | Modifier | Type | Description | Inherited from |
---|---|---|---|---|
chatbot | readonly | ChatBot <T > | The current instance of the chatbot. | Base.chatbot |
Methods
add()
Timeout a specific user.
Parameters
Parameter | Type | Description |
---|---|---|
chatroomId | string | The id of the chatroom where the user will be sent into a timeout. |
options | TimeoutOptions | The 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()
Deletes the timeout of a specific user.
Parameters
Parameter | Type | Description |
---|---|---|
chatroomId | string | The id of the chatroom where the user will be removed from the timeout. |
userId | string | The id of the user to remove from the timeout. |
Returns
Promise
<void
>
Source
twitchfy/packages/chatbot/src/structures/managers/ChatBotTimeoutManager.ts:36