Class GuildVoiceChannel

Hierarchy

BaseTextChannelInGuild
- GuildVoiceChannel

Index

Constructors

constructor

new GuildVoiceChannel(client: Client): GuildVoiceChannel

Inherited from BaseTextChannelInGuild.constructor
- Defined in src/structures/templates/BaseTextChannel.ts:38
Parameters
- client: Client
Returns GuildVoiceChannel

Properties

bitrate

bitrate: null | number = null

client

client: Client

guildId

guildId: null | string = null

id

id: string

lastMessageId

lastMessageId: null | string = null

messages

messages: ChannelMessageManager = ...

name

name: string = ''

nsfw

nsfw: boolean = false

parentId

parentId: null | string = null

position

position: number = 0

region

region: null | string = null

type

type: ChannelType = ChannelType.GuildCategory

userLimit

userLimit: null | number = null

videoQuality

videoQuality: VideoQualityMode = VideoQualityMode.Auto

Accessors

children

get children(): GuildChannels[]

Inherited from BaseTextChannelInGuild.children
- Defined in src/structures/GuildChannel.ts:23
Returns GuildChannels[]

createMessage

get createMessage(): (data: string | MessagePayload | MessagePayloadData, cache?: boolean) => Promise<Message<TextChannel>>

Inherited from BaseTextChannelInGuild.createMessage
- Defined in src/structures/templates/BaseTextChannel.ts:56
Returns (data: string | MessagePayload | MessagePayloadData, cache?: boolean) => Promise<Message<TextChannel>>
- - (data: string | MessagePayload | MessagePayloadData, cache?: boolean): Promise<Message<TextChannel>>
  - Parameters
    - data: string | MessagePayload | MessagePayloadData
    - cache: boolean = false
    Returns Promise<Message<TextChannel>>

createdAt

get createdAt(): Date

Inherited from BaseTextChannelInGuild.createdAt
- Defined in src/structures/templates/BaseStructure.ts:12
Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from BaseTextChannelInGuild.createdTimestamp
- Defined in src/structures/templates/BaseStructure.ts:9
Returns number

delete

get delete(): (...args: [reason?: string]) => Promise<void>

Inherited from BaseTextChannelInGuild.delete
- Defined in src/structures/GuildChannel.ts:93
Returns (...args: [reason?: string]) => Promise<void>
- - (...args: [reason?: string]): Promise<void>
  - Parameters
    - Rest ...args: [reason?: string]
    Returns Promise<void>

guild

get guild(): null | Guild

Inherited from BaseTextChannelInGuild.guild
- Defined in src/structures/Channel.ts:23
Returns null | Guild

parent

get parent(): undefined | GuildChannels

Inherited from BaseTextChannelInGuild.parent
- Defined in src/structures/GuildChannel.ts:19
Returns undefined | GuildChannels

Methods

_deserialise

_deserialise(data: any): GuildVoiceChannel

Overrides BaseTextChannelInGuild._deserialise
- Defined in src/structures/GuildVoiceChannel.ts:10
Parameters
- data: any
Returns GuildVoiceChannel

_set_guild

_set_guild(id: string): GuildVoiceChannel

Inherited from BaseTextChannelInGuild._set_guild
- Defined in src/structures/Channel.ts:35
Parameters
- id: string
Returns GuildVoiceChannel

createStageInstance

createStageInstance(): void

- Defined in src/structures/GuildVoiceChannel.ts:50
Returns void

fetch

fetch(): Promise<GuildVoiceChannel>

Inherited from BaseTextChannelInGuild.fetch
- Defined in src/structures/Channel.ts:81
Returns Promise<GuildVoiceChannel>

setBitrate

setBitrate(bitrate: number): Promise<GuildVoiceChannel>

- Defined in src/structures/GuildVoiceChannel.ts:33
Parameters
- bitrate: number
Returns Promise<GuildVoiceChannel>

setName

setName(name: string): Promise<GuildVoiceChannel>

Inherited from BaseTextChannelInGuild.setName
- Defined in src/structures/GuildChannel.ts:73
Parameters
- name: string
Returns Promise<GuildVoiceChannel>

setNsfw

setNsfw(nsfw: boolean): Promise<GuildVoiceChannel>

Inherited from BaseTextChannelInGuild.setNsfw
- Defined in src/structures/GuildChannel.ts:81
Parameters
- nsfw: boolean
Returns Promise<GuildVoiceChannel>

setParent

setParent(parent: string | GuildChannels): void

Inherited from BaseTextChannelInGuild.setParent
- Defined in src/structures/GuildChannel.ts:85
Parameters
- parent: string | GuildChannels
Returns void

setPosition

setPosition(position: number): Promise<GuildVoiceChannel>

Inherited from BaseTextChannelInGuild.setPosition
- Defined in src/structures/GuildChannel.ts:77
Parameters
- position: number
Returns Promise<GuildVoiceChannel>

setRegion

setRegion(region: string): Promise<GuildVoiceChannel>

- Defined in src/structures/GuildVoiceChannel.ts:37
Parameters
- region: string
Returns Promise<GuildVoiceChannel>

setUserLimit

setUserLimit(userLimit: number): Promise<GuildVoiceChannel>

- Defined in src/structures/GuildVoiceChannel.ts:41
Parameters
- userLimit: number
Returns Promise<GuildVoiceChannel>

setVideoQualityMode

setVideoQualityMode(mode: VideoQualityMode): Promise<GuildVoiceChannel>

- Defined in src/structures/GuildVoiceChannel.ts:45
Parameters
- mode: VideoQualityMode
Returns Promise<GuildVoiceChannel>

toJSON

toJSON(): APIVoiceChannel

Overrides BaseTextChannelInGuild.toJSON
- Defined in src/structures/GuildVoiceChannel.ts:22
Returns APIVoiceChannel

Static create

create(client: Client, data: APIChannelBase<ChannelType> & { guild_id?: string }): Channels<DMChannel | GuildChannels | Channel<APIChannel>, APIChannel>

Inherited from BaseTextChannelInGuild.create
- Defined in src/structures/Channel.ts:40
Parameters
- client: Client
- data: APIChannelBase<ChannelType> & { guild_id?: string }
Returns Channels<DMChannel | GuildChannels | Channel<APIChannel>, APIChannel>

Static resolve

resolve(client: Client, data: APIGuildChannel<GuildChannelType>, guild: Guild): GuildChannels

Inherited from BaseTextChannelInGuild.resolve
- Defined in src/structures/GuildChannel.ts:43
Creates a type-strong version of the channel, based on its type.

Parameters
- client: Client
- data: APIGuildChannel<GuildChannelType>
- guild: Guild
Returns GuildChannels

Static toJSON

toJSON(data: any): any

Inherited from BaseTextChannelInGuild.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc