Class CategoryChannel

Hierarchy

GuildChannel
- CategoryChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CategoryChannel(data: BaseData, guild: Guild): CategoryChannel

Inherited from GuildChannel.constructor
- Defined in node_modules/eris/index.d.ts:1959
Parameters
- data: BaseData
- guild: Guild
Returns CategoryChannel

Properties

channels

channels: Collection<TextChannel | NewsChannel | VoiceChannel | StageChannel | StoreChannel>

client

client: Client

createdAt

createdAt: number

guild

guild: Guild

id

id: string

mention

mention: string

name

name: string

nsfw

nsfw: boolean

parentID

parentID: null | string

permissionOverwrites

permissionOverwrites: Collection<PermissionOverwrite>

position

position: number

type

type: 4

Methods

delete

delete(reason?: string): Promise<void>

Inherited from GuildChannel.delete
- Defined in node_modules/eris/index.d.ts:1961
Parameters
- Optional reason: string
Returns Promise<void>

deletePermission

deletePermission(overwriteID: string, reason?: string): Promise<void>

Inherited from GuildChannel.deletePermission
- Defined in node_modules/eris/index.d.ts:1962
Parameters
- overwriteID: string
- Optional reason: string
Returns Promise<void>

edit

edit(options: Pick<CreateChannelOptions, "bitrate" | "nsfw" | "parentID" | "rateLimitPerUser" | "topic" | "userLimit">, reason?: string): Promise<CategoryChannel>

Overrides GuildChannel.edit
- Defined in node_modules/eris/index.d.ts:1315
Parameters
- options: Pick<CreateChannelOptions, "bitrate" | "nsfw" | "parentID" | "rateLimitPerUser" | "topic" | "userLimit">
- Optional reason: string
Returns Promise<CategoryChannel>

editPermission

editPermission(overwriteID: string, allow: number | bigint, deny: number | bigint, type: PermissionType, reason?: string): Promise<PermissionOverwrite>

Inherited from GuildChannel.editPermission
- Defined in node_modules/eris/index.d.ts:1964
Parameters
- overwriteID: string
- allow: number | bigint
- deny: number | bigint
- type: PermissionType
- Optional reason: string
Returns Promise<PermissionOverwrite>

editPosition

editPosition(position: number, options?: EditChannelPositionOptions): Promise<void>

Inherited from GuildChannel.editPosition
- Defined in node_modules/eris/index.d.ts:1971
Parameters
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

getInvites

getInvites(): Promise<Invite<"withMetadata", InviteChannel>[]>

Inherited from GuildChannel.getInvites
- Defined in node_modules/eris/index.d.ts:1972
Returns Promise<Invite<"withMetadata", InviteChannel>[]>

inspect

inspect(): CategoryChannel

Inherited from GuildChannel.inspect
- Defined in node_modules/eris/index.d.ts:1262
Returns CategoryChannel

permissionsOf

permissionsOf(memberID: string | Member): Permission

Inherited from GuildChannel.permissionsOf
- Defined in node_modules/eris/index.d.ts:1973
Parameters
- memberID: string | Member
Returns Permission

toJSON

toJSON(props?: string[]): JSONCache

Inherited from GuildChannel.toJSON
- Defined in node_modules/eris/index.d.ts:1264
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

Inherited from GuildChannel.toString
- Defined in node_modules/eris/index.d.ts:1263
Returns string

Static from

from(data: BaseData, client: Client): AnyChannel

Inherited from GuildChannel.from
- Defined in node_modules/eris/index.d.ts:1325
Parameters
- data: BaseData
- client: Client
Returns AnyChannel

Generated using TypeDoc