Skip to content

ChatBotWarnsManager

The warns manager of the chatbot.

Extends

  • Base<T>

Type parameters

Type parameter
T extends EventSubConnection

Constructors

new ChatBotWarnsManager()

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

Creates a new instance of the warns manager.

Parameters

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

Returns

ChatBotWarnsManager<T>

Overrides

Base<T>.constructor

Source

twitchfy/packages/chatbot/src/structures/managers/ChatBotWarnsManager.ts:15

Properties

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

Methods

create()

1
create(
2
chatroomId: string,
3
userId: string,
4
reason: string): Promise<Warning<T>>

Creates warn for an user in a specific chatroom.

Parameters

ParameterTypeDescription
chatroomIdstringThe id of the chatroom where the user will be warned.
userIdstringThe id of the user to warn.
reasonstring-

Returns

Promise<Warning<T>>

Source

twitchfy/packages/chatbot/src/structures/managers/ChatBotWarnsManager.ts:25