BaseChannel

Extends

Base<T>

Extended by

Channel

Type parameters

Type parameter	Value
`T` extends `EventSubConnection`	`EventSubConnection`

Constructors

new BaseChannel()

1
new BaseChannel<T>(
2
   chatbot: ChatBot<T>,
3
   data: BaseChannelData,
4
chatroom: ChatRoom<T>): BaseChannel<T>

Parameters

Parameter	Type
`chatbot`	`ChatBot`<`T`>
`data`	`BaseChannelData`
`chatroom`	`ChatRoom`<`T`>

Returns

BaseChannel<T>

Overrides

Base<T>.constructor

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:27

Properties

Property	Modifier	Type	Description	Inherited from
`broadcaster`	`readonly`	`BaseUser`<`T`>	The broadcaster of the channel.	-
`chatbot`	`readonly`	`ChatBot`<`T`>	The current instance of the chatbot.	`Base.chatbot`
`chatroom`	`readonly`	`ChatRoom`<`T`>	The chatroom of the channel.	-
`id`	`readonly`	`string`	The id of the channel.	-

Accessors

bans

1
get bans(): BanManager<T>

The chatroom bans manager. See BanManager.

Returns

BanManager<T>

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:51

broadcasterId

1
get broadcasterId(): string

The id of the broadcaster who owns the channel.

Returns

string

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:37

chatroomId

1
get chatroomId(): string

The id of the chatroom of the channel.

Returns

string

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:44

chatters

1
get chatters(): ChatterManager<T>

The chatroom chatters manager. See ChatterManager.

Returns

ChatterManager<T>

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:81

messages

1
get messages(): MessageManager<T>

The chatroom messages manager. See MessageManager.

Returns

MessageManager<T>

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:65

timeouts

1
get timeouts(): TimeoutManager<T>

The chatroom timeouts manager. See TimeoutManager.

Returns

TimeoutManager<T>

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:58

warns

1
get warns(): WarnsManager<T>

The chatroom warns manager. See WarnsManager.

Returns

WarnsManager<T>

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:73

Methods

clips()

1
clips(options?: Omit<GetClipsOptions<true>, "broadcaster_id">): Promise<null | Clip<T>[]>

Fetches the clips of the channel from the API.

Parameters

Parameter	Type	Description
`options`?	`Omit`<`GetClipsOptions`<`true`>, `"broadcaster_id"`>	The options to fetch the clips.

Returns

Promise<null | Clip<T>[]>

An array containing the clips of the channel.

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:106

emotes()

1
emotes(): Promise<Collection<string, ChannelEmote<T>>>

Fetches all the emotes of this channel.

Returns

Promise<Collection<string, ChannelEmote<T>>>

The a Collection containing all the emotes of the channel.

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:88

fetch()

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

Fetches the current channel from the API.

Returns

Promise<Channel<T>>

The fetched channel from the API.

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:119

isModerator()

1
isModerator(): Promise<boolean>

Returns

Promise<boolean>

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:111

stream()

1
stream(): Promise<null | Stream<T>>

Fetches the current stream of the channel from the API.

Returns

Promise<null | Stream<T>>

The current stream or null if the stream is offline.

Source

twitchfy/packages/chatbot/src/structures/BaseChannel.ts:97