hoshii / Exports / ServerChannel

ServerChannel

Represents a base item

Hierarchy

• Base<string>

  ↳ ServerChannel

  ↳↳ CalendarChannel

  ↳↳ DocChannel

  ↳↳ ForumChannel

  ↳↳ TextChannel

Table of contents

Constructors

• constructor

Properties

• archivedAt
• archivedBy
• categoryID
• client
• createdAt
• createdBy
• groupID
• id
• isPublic
• name
• parentID
• serverID
• topic
• type
• updatedAt

Methods

• delete
• edit
• toJSON
• update

Constructors

constructor

• new ServerChannel(data, client)

Create a new ServerChannel

Parameters

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

Overrides

Base.constructor

Defined in

lib/structures/ServerChannel.ts:115

Properties

archivedAt

• archivedAt: Date

The date the server channel was archived at

Defined in

lib/structures/ServerChannel.ts:48

---

archivedBy

• archivedBy: string

The ID of the user that archived the server channel

Defined in

lib/structures/ServerChannel.ts:53

---

categoryID

• categoryID: string

The ID of the category the server channel is in

Defined in

lib/structures/ServerChannel.ts:58

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

createdAt

• createdAt: Date

The date the server channel was created at

Defined in

lib/structures/ServerChannel.ts:63

---

createdBy

• createdBy: string

The ID of the user that created the server channel

Defined in

lib/structures/ServerChannel.ts:68

---

groupID

• groupID: string

The ID of the group the server channel is in

Defined in

lib/structures/ServerChannel.ts:73

---

id

• id: string

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

isPublic

• isPublic: boolean

Whether the server channel is public

Defined in

lib/structures/ServerChannel.ts:78

---

name

• name: string

The name of the server channel

Defined in

lib/structures/ServerChannel.ts:83

---

parentID

• parentID: string

The ID of the parent the server channel is in

Defined in

lib/structures/ServerChannel.ts:88

---

serverID

• serverID: string

The ID of the server the server channel is in

Defined in

lib/structures/ServerChannel.ts:93

---

topic

• topic: string

The topic of the server channel

Defined in

lib/structures/ServerChannel.ts:98

---

type

• type: ServerChannelCategories

The type of the server channel

Defined in

lib/structures/ServerChannel.ts:103

---

updatedAt

• updatedAt: Date

The date the server channel was updated at

Defined in

lib/structures/ServerChannel.ts:108

Methods

delete

▸ delete(): Promise<void>

Deletes the server channel

Returns

Promise<void>

Defined in

lib/structures/ServerChannel.ts:139

---

edit

▸ edit(options): Promise<ServerChannel>

Edits the server channel

Parameters

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

Returns

Promise<ServerChannel>

Defined in

lib/structures/ServerChannel.ts:149

---

toJSON

▸ toJSON(): ServerChannelData

Returns the JSON representation of the item

Returns

ServerChannelData

Overrides

Base.toJSON

Defined in

lib/structures/ServerChannel.ts:153

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawServerChannel

Returns

void

Overrides

Base.update

Defined in

lib/structures/ServerChannel.ts:172