Class GuildChannelAbstract

constructor

• new GuildChannel(
      guild: Guild,
      data?: RawGuildChannelData,
      client?: Client<true>,
      immediatePatch?: boolean,
  ): GuildChannel

  Parameters

  • guild: Guild
  • Optionaldata: RawGuildChannelData
  • Optionalclient: Client<true>
  • OptionalimmediatePatch: boolean

  Returns GuildChannel

flags

guild

guildId

name

parentId

permissionOverwrites

rawPosition

type

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>

parent

• get parent(): null | CategoryChannel

  Returns null | CategoryChannel

permissionsLocked

• get permissionsLocked(): null | boolean

  Returns null | boolean

position

• get position(): number

  Returns number

viewable

• get viewable(): boolean

  Returns boolean

clone

• clone(options?: GuildChannelCloneOptions): Promise<GuildChannel>

  Parameters

  • Optionaloptions: GuildChannelCloneOptions

  Returns Promise<GuildChannel>

delete

• delete(reason?: string): Promise<GuildChannel>

  Parameters

  • Optionalreason: string

  Returns Promise<GuildChannel>

edit

• edit(options: GuildChannelEditOptions): Promise<GuildChannel>

  Parameters

  • options: GuildChannelEditOptions

  Returns Promise<GuildChannel>

equals

• equals(channel: GuildChannel): boolean

  Parameters

  • channel: GuildChannel

  Returns boolean

isTextBased

• isTextBased(): this is GuildBasedChannel & TextBasedChannel

  Returns this is GuildBasedChannel & TextBasedChannel

lockPermissions

• lockPermissions(): Promise<GuildChannel>

  Returns Promise<GuildChannel>

permissionsFor

• permissionsFor(
      memberOrRole: GuildMember | Role,
      checkAdmin?: boolean,
  ): Readonly<PermissionsBitField>

  Parameters

  • memberOrRole: GuildMember | Role
  • OptionalcheckAdmin: boolean

  Returns Readonly<PermissionsBitField>

• permissionsFor(
      memberOrRole:
          | string
          | User
          | GuildMember
          | Role
          | Message<boolean>
          | ThreadMember<boolean>,
      checkAdmin?: boolean,
  ): null | Readonly<PermissionsBitField>

  Parameters

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

  Returns null | Readonly<PermissionsBitField>

setName

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

  Parameters

  • name: string
  • Optionalreason: string

  Returns Promise<GuildChannel>

setParent

• setParent(
      channel: null | CategoryChannelResolvable,
      options?: SetParentOptions,
  ): Promise<GuildChannel>

  Parameters

  • channel: null | CategoryChannelResolvable
  • Optionaloptions: SetParentOptions

  Returns Promise<GuildChannel>

setPosition

• setPosition(
      position: number,
      options?: SetChannelPositionOptions,
  ): Promise<GuildChannel>

  Parameters

  • position: number
  • Optionaloptions: SetChannelPositionOptions

  Returns Promise<GuildChannel>

toString

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

  Returns a string representation of an object.

  Returns `<#${string}>`