Class: Channel

Represents a chat channel.

Hierarchy

• Base

  ↳ Channel

Constructors

constructor

• new Channel(client, name): Channel

Parameters

Name	Type
client	Client
name	string

Returns

Channel

Overrides

Base.constructor

Properties

client

• client: Client

Inherited from

Base.client

---

name

• name: string

The channel name

Methods

getPlayers

▸ getPlayers(): Promise<TribullePlayer[]>

Get player list inside this chat channel

Returns

Promise<TribullePlayer[]>

---

join

▸ join(permanent?): void

Join to this chat channel

Parameters

Name	Type
permanent?	boolean

Returns

void

---

leave

▸ leave(): void

Leave this chat channel

Returns

void

---

sendMessage

▸ sendMessage(message): void

Send a message to this channel

Parameters

Name	Type
message	string

Returns

void