ChatRoomSettingsManager
Represents the manager for the settings of a chatroom.
Extends
Base<T>
Type parameters
| Type parameter |
|---|
T extends EventSubConnection |
Constructors
new ChatRoomSettingsManager()
1new ChatRoomSettingsManager<T>(chatbot: ChatBot<T>, chatroom: ChatRoom<T>): ChatRoomSettingsManager<T>Creates a new instance of the chatroom settings manager.
Parameters
| Parameter | Type | Description |
|---|---|---|
chatbot | ChatBot<T> | The current instance of the chatbot. |
chatroom | ChatRoom<T> | The settings’ chatroom. |
Returns
Overrides
Base<T>.constructor
Source
twitchfy/packages/chatbot/src/structures/managers/ChatRoomSettingsManager.ts:23
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
chatbot | readonly | ChatBot<T> | The current instance of the chatbot. | Base.chatbot |
chatroom | readonly | ChatRoom<T> | The settings’ chatroom. | - |
Methods
edit()
1edit(options: PatchChatSettingsBody): Promise<ChatRoomSettings<T>>Edits the chatroom settings with the API.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | PatchChatSettingsBody | The options to edit the chatroom settings. |
Returns
Promise<ChatRoomSettings<T>>
The new settings of the chatroom.
Source
twitchfy/packages/chatbot/src/structures/managers/ChatRoomSettingsManager.ts:33
fetch()
1fetch(): Promise<ChatRoomSettings<T>>Fetches the current settings of the chatroom from the API.
Returns
Promise<ChatRoomSettings<T>>
The current settings of the chatroom.
Source
twitchfy/packages/chatbot/src/structures/managers/ChatRoomSettingsManager.ts:41