Class DocChannel

Represents a "docs" channel.

Hierarchy

GuildChannel
- DocChannel

Index

Constructors

Properties

archivedAt archivedBy categoryID client createdAt creatorID description docs editedTimestamp groupID guildID id isPublic name parentID type visibility

Methods

archive createDoc delete deleteDoc edit editDoc toJSON unarchive

Constructors

constructor

new DocChannel(data, client): DocChannel
Parameters
- data: APIGuildChannel
  
  raw data
- client: Client
  
  client
Returns DocChannel
Overrides GuildChannel.constructor
- Defined in lib/structures/DocChannel.ts:19

Properties

archivedAt

archivedAt: null | Date

When the channel was last archived.

archivedBy

archivedBy: null | string

ID of the member that archived the channel (if archived)

categoryID

categoryID: null | number

ID of the category the channel is in.

client

client: Client

Bot's client.

createdAt

createdAt: Date

When this channel was created.

creatorID

creatorID: string

ID of the member who created this channel.

description

description: null | string

Channel description

docs

docs: TypedCollection<number, APIDoc, Doc, []>

Cached docs.

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

groupID

groupID: string

ID of the group the channel is in.

guildID

guildID: string

Server ID

id

id: string

Item ID

isPublic

isPublic: boolean

name

name: string

Channel name

parentID

parentID: null | string

ID of the parent category.

type

type: string

Channel type

visibility

visibility: string

Channel visibility

Methods

createDoc

createDoc(options): Promise<Doc>
Create a doc in this channel.
Parameters
- options: CreateDocOptions
  
  Doc's options.
Returns Promise<Doc>
- Defined in lib/structures/DocChannel.ts:28

delete

delete(): Promise<void>
Delete the channel.

Returns Promise<void>
Inherited from GuildChannel.delete
- Defined in lib/structures/GuildChannel.ts:148

deleteDoc

deleteDoc(docID): Promise<void>
Delete a doc from this channel.
Parameters
- docID: number
  
  ID of a doc.
Returns Promise<void>
- Defined in lib/structures/DocChannel.ts:43

edit

edit(options): Promise<Channel>
Edit the channel.
Parameters
- options: EditChannelOptions
Returns Promise<Channel>
Inherited from GuildChannel.edit
- Defined in lib/structures/GuildChannel.ts:143

editDoc

editDoc(docID, options): Promise<Doc>
Edit a doc from this channel.
Parameters
- docID: number
  
  ID of a doc.
- options: EditDocOptions
  
  Edit options.
Returns Promise<Doc>
- Defined in lib/structures/DocChannel.ts:36

toJSON

toJSON(): JSONDocChannel
Returns JSONDocChannel
Overrides GuildChannel.toJSON
- Defined in lib/structures/DocChannel.ts:47

unarchive

unarchive(): Promise<void>
Unarchive the channel

Returns Promise<void>
Inherited from GuildChannel.unarchive
- Defined in lib/structures/GuildChannel.ts:158

Class DocChannel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: APIGuildChannel

client: Client

Returns DocChannel

Properties

archivedAt

archivedBy

categoryID

client

createdAt

creatorID

description

docs

editedTimestamp

groupID

guildID

id

isPublic

name

parentID

type

visibility

Methods

archive

Returns Promise<void>

createDoc

Parameters

options: CreateDocOptions

Returns Promise<Doc>

delete

Returns Promise<void>

deleteDoc

Parameters

docID: number

Returns Promise<void>

edit

Parameters

options: EditChannelOptions

Returns Promise<Channel>

editDoc

Parameters

docID: number

options: EditDocOptions

Returns Promise<Doc>

toJSON

Returns JSONDocChannel

unarchive

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page