hoshii / Exports / Channel

Channel

Represents a channel

Hierarchy

• Base<string>

  ↳ Channel

Table of contents

Constructors

• constructor

Properties

• client
• id
• name
• type

Methods

• delete
• edit
• toJSON
• update
• from

Constructors

constructor

• new Channel(data, client)

Create a new Channel

Parameters

Name	Type	Description
data	RawServerChannel	The raw data of the channel
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/Channel.ts:38

Properties

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

id

• id: string

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

name

• name: string

The name of the channel

Defined in

lib/structures/Channel.ts:26

---

type

• type: ServerChannelCategories

The type of the channel

Defined in

lib/structures/Channel.ts:31

Methods

delete

▸ delete(): Promise<void>

Delete the channel

Returns

Promise<void>

Defined in

lib/structures/Channel.ts:49

---

edit

▸ edit(options): Promise<Channel>

Edit the channel

Parameters

Name	Type	Description
options	ServerChannelEditOptions	The options to edit the channel with

Returns

Promise<Channel>

Defined in

lib/structures/Channel.ts:58

---

toJSON

▸ toJSON(): ChannelData

Returns the JSON representation of the item

Returns

ChannelData

Overrides

Base.toJSON

Defined in

lib/structures/Channel.ts:92

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	unknown

Returns

void

Inherited from

Base.update

Defined in

lib/structures/Base.ts:64

---

from

▸ Static from<T>(data, client): T

Type parameters

Name	Type
T	extends AnyChannel = AnyChannel

Parameters

Name	Type
data	RawServerChannel
client	Client

Returns

T

Defined in

lib/structures/Channel.ts:62