ChannelProfile

Represents a channel profile created when the chatbot joins to a channel.

Extends

Base<T>

Type parameters

Type parameter
`T` extends `EventSubConnection`

Constructors

new ChannelProfile()

1
new ChannelProfile<T>(chatbot: ChatBot<T>, data: ChannelProfileData): ChannelProfile<T>

Creates a new instance of the channel profile.

Parameters

Parameter	Type	Description
`chatbot`	`ChatBot`<`T`>	The current instance of the chatbot.
`data`	`ChannelProfileData`	The data of the channel profile.

Returns

ChannelProfile<T>

Overrides

Base<T>.constructor

Source

twitchfy/packages/chatbot/src/structures/ChannelProfile.ts:28

Properties

Property	Modifier	Type	Description	Inherited from
`chatbot`	`readonly`	`ChatBot`<`T`>	The current instance of the chatbot.	`Base.chatbot`
`events`	`readonly`	( \| `"ChannelChatClear"` \| `"ChannelFollow"` \| `"ChannelUpdate"` \| `"StreamOnline"` \| `"ChannelChatMessage"` \| `"StreamOffline"`)[]	The events from the channel that the chatbot is subscribed to.	-
`id`	`readonly`	`string`	The Id of the channel.	-

Methods

addEvent()

addEvent(event)

1
addEvent(event:
2
  | "ChannelChatClear"
3
  | "ChannelFollow"
4
  | "ChannelUpdate"
5
  | "StreamOnline"
6
  | "ChannelChatMessage"
7
| "StreamOffline"): Promise<void>

Adds an event or events to the channel profile and listen to it. If the event is already added, it does nothing.

Parameters

Parameter	Type	Description
`event`	\| `"ChannelChatClear"` \| `"ChannelFollow"` \| `"ChannelUpdate"` \| `"StreamOnline"` \| `"ChannelChatMessage"` \| `"StreamOffline"`	The event or events to add.

Returns

Promise<void>

Source

twitchfy/packages/chatbot/src/structures/ChannelProfile.ts:34

addEvent(event)

1
addEvent(event: (
2
  | "ChannelChatClear"
3
  | "ChannelFollow"
4
  | "ChannelUpdate"
5
  | "StreamOnline"
6
  | "ChannelChatMessage"
7
| "StreamOffline")[]): Promise<void>

Adds an event or events to the channel profile and listen to it. If the event is already added, it does nothing.

Parameters

Parameter	Type	Description
`event`	( \| `"ChannelChatClear"` \| `"ChannelFollow"` \| `"ChannelUpdate"` \| `"StreamOnline"` \| `"ChannelChatMessage"` \| `"StreamOffline"`)[]	The event or events to add.

Returns

Promise<void>

Source

twitchfy/packages/chatbot/src/structures/ChannelProfile.ts:35

fetch()

1
fetch(): Promise<Channel<T>>

Fetches the current channel of the profile from the API.

Returns

Promise<Channel<T>>

The fetched channel from the API.

Source

twitchfy/packages/chatbot/src/structures/ChannelProfile.ts:76

hasEvent()

1
hasEvent(event:
2
  | "ChannelChatClear"
3
  | "ChannelFollow"
4
  | "ChannelUpdate"
5
  | "StreamOnline"
6
  | "ChannelChatMessage"
7
  | "StreamOffline"): boolean

Checks if one event is being listened.

Parameters

Parameter	Type	Description
`event`	\| `"ChannelChatClear"` \| `"ChannelFollow"` \| `"ChannelUpdate"` \| `"StreamOnline"` \| `"ChannelChatMessage"` \| `"StreamOffline"`	The event to check.

Returns

boolean

Source

twitchfy/packages/chatbot/src/structures/ChannelProfile.ts:68

removeEvent()

1
removeEvent(event:
2
  | "ChannelChatClear"
3
  | "ChannelFollow"
4
  | "ChannelUpdate"
5
  | "StreamOnline"
6
  | "ChannelChatMessage"
7
| "StreamOffline"): Promise<void>

Removes an event from the channel profile and stop listening to it. If the event is not added, it does nothing.

Parameters

Parameter	Type	Description
`event`	\| `"ChannelChatClear"` \| `"ChannelFollow"` \| `"ChannelUpdate"` \| `"StreamOnline"` \| `"ChannelChatMessage"` \| `"StreamOffline"`	The event to remove.

Returns

Promise<void>

Source

twitchfy/packages/chatbot/src/structures/ChannelProfile.ts:57