Class CategoryChannel

constructor

• new CategoryChannel(guild, data?, client?, immediatePatch?): CategoryChannel

• Parameters

  • guild: Guild

  • Optional data: RawGuildChannelData

  • Optional client: Client<true>

  • Optional immediatePatch: boolean

  Returns CategoryChannel

Readonly client

flags

guild

guildId

id

name

permissionOverwrites

rawPosition

createdAt

• get createdAt(): Date

• Returns Date

createdTimestamp

• get createdTimestamp(): number

• Returns number

deletable

• get deletable(): boolean

• Returns boolean

manageable

• get manageable(): boolean

• Returns boolean

members

• get members(): Collection<string, GuildMember>

• Returns Collection<string, GuildMember>

partial

• get partial(): false

• Returns false

permissionsLocked

• get permissionsLocked(): null | boolean

• Returns null | boolean

position

• get position(): number

• Returns number

url

• get url(): string

• Returns string

viewable

• get viewable(): boolean

• Returns boolean

clone

• clone(options?): Promise<CategoryChannel>

• Parameters

  • Optional options: GuildChannelCloneOptions

  Returns Promise<CategoryChannel>

delete

• delete(reason?): Promise<CategoryChannel>

• Parameters

  • Optional reason: string

  Returns Promise<CategoryChannel>

edit

• edit(options): Promise<CategoryChannel>

• Parameters

  • options: GuildChannelEditOptions

  Returns Promise<CategoryChannel>

equals

• equals(channel): boolean

• Parameters

  • channel: GuildChannel

  Returns boolean

fetch

• fetch(force?): Promise<CategoryChannel>

• Parameters

  • Optional force: boolean

  Returns Promise<CategoryChannel>

isDMBased

• isDMBased(): this is DMChannel | PartialDMChannel | PartialGroupDMChannel

• Returns this is DMChannel | PartialDMChannel | PartialGroupDMChannel

isTextBased

• isTextBased(): this is GuildBasedChannel & TextBasedChannel

• Returns this is GuildBasedChannel & TextBasedChannel

isThread

• isThread(): this is AnyThreadChannel

• Returns this is AnyThreadChannel

isThreadOnly

• isThreadOnly(): this is ThreadOnlyChannel

• Returns this is ThreadOnlyChannel

isVoiceBased

• isVoiceBased(): this is VoiceBasedChannel

• Returns this is VoiceBasedChannel

lockPermissions

• lockPermissions(): Promise<CategoryChannel>

• Returns Promise<CategoryChannel>

permissionsFor

• permissionsFor(memberOrRole, checkAdmin?): Readonly<PermissionsBitField>

• Parameters

  • memberOrRole: GuildMember | Role

  • Optional checkAdmin: boolean

  Returns Readonly<PermissionsBitField>

• permissionsFor(memberOrRole, checkAdmin?): null | Readonly<PermissionsBitField>

• Parameters

  • memberOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>

  • Optional checkAdmin: boolean

  Returns null | Readonly<PermissionsBitField>

setName

• setName(name, reason?): Promise<CategoryChannel>

• Parameters

  • name: string

  • Optional reason: string

  Returns Promise<CategoryChannel>

setParent

• setParent(channel, options?): Promise<CategoryChannel>

• Parameters

  • channel: null | CategoryChannelResolvable

  • Optional options: SetParentOptions

  Returns Promise<CategoryChannel>

setPosition

• setPosition(position, options?): Promise<CategoryChannel>

• Parameters

  • position: number

  • Optional options: SetChannelPositionOptions

  Returns Promise<CategoryChannel>

toJSON

• toJSON(...props): unknown

• Parameters

  • Rest ...props: Record<string, string | boolean>[]

  Returns unknown

toString

• toString(): `<#${string}>`

• Returns `<#${string}>`

valueOf

• valueOf(): string

• Returns string