Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GuildChannel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

client

client: Client

createdAt

createdAt: number

guild

guild: Guild

id

id: string

mention

mention: string

name

name: string

nsfw

nsfw: boolean

Optional parentID

parentID: undefined | string

permissionOverwrites

permissionOverwrites: Collection<PermissionOverwrite>

position

position: number

type

type: 0 | 2 | 4 | 5 | 6

Methods

createInvite

delete

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

  • Parameters

    • Optional reason: string

    Returns Promise<void>

deletePermission

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

  • Parameters

    • overwriteID: string
    • Optional reason: string

    Returns Promise<void>

edit

  • edit(options: { bitrate?: undefined | number; name?: undefined | string; nsfw?: undefined | boolean; parentID?: undefined | string; rateLimitPerUser?: undefined | number; topic?: undefined | string; userLimit?: undefined | number }, reason?: string): Promise<GuildChannel>

  • Parameters

    • options: { bitrate?: undefined | number; name?: undefined | string; nsfw?: undefined | boolean; parentID?: undefined | string; rateLimitPerUser?: undefined | number; topic?: undefined | string; userLimit?: undefined | number }
      • Optional bitrate?: undefined | number
      • Optional name?: undefined | string
      • Optional nsfw?: undefined | boolean
      • Optional parentID?: undefined | string
      • Optional rateLimitPerUser?: undefined | number
      • Optional topic?: undefined | string
      • Optional userLimit?: undefined | number
    • Optional reason: string

    Returns Promise<GuildChannel>

editPermission

  • editPermission(overwriteID: string, allow: number, deny: number, type: "role" | "member", reason?: string): Promise<PermissionOverwrite>

  • Parameters

    • overwriteID: string
    • allow: number
    • deny: number
    • type: "role" | "member"
    • Optional reason: string

    Returns Promise<PermissionOverwrite>

editPosition

  • editPosition(position: number): Promise<void>

  • Parameters

    • position: number

    Returns Promise<void>

getInvites

  • Returns Promise<ChannelInvite[]>

inspect

permissionsOf

  • Parameters

    • memberID: string

    Returns Permission

toJSON

  • Parameters

    • Optional props: string[]

    Returns JSONCache

Static from

Generated using TypeDoc