GuildVoiceChannel
Extends
GuildStageOrVoiceChannel<ChannelType.GuildVoice,IsPartial>
Type Parameters
| Type Parameter | Default type |
|---|---|
IsPartial extends boolean | false |
Constructors
Constructor
new GuildVoiceChannel<
IsPartial>(client,rawDataOrId):GuildVoiceChannel<IsPartial>
Parameters
| Parameter | Type |
|---|---|
client | Client |
rawDataOrId | IsPartial extends true ? string : APIGuildVoiceChannel |
Returns
GuildVoiceChannel<IsPartial>
Inherited from
GuildStageOrVoiceChannel.constructor
Properties
| Property | Modifier | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
client | public | Client | - | - | GuildStageOrVoiceChannel.client |
id | readonly | string | The id of the channel. | - | GuildStageOrVoiceChannel.id |
rawData | public | null | APIGuildVoiceChannel | The raw data of the channel. | GuildStageOrVoiceChannel.rawData | - |
Accessors
bitrate
Get Signature
get bitrate():
IfPartial<IsPartial,undefined|number>
The bitrate of the channel.
Returns
IfPartial<IsPartial, undefined | number>
Inherited from
GuildStageOrVoiceChannel.bitrate
flags
Get Signature
get flags():
IfPartial<IsPartial,undefined|ChannelFlags>
The flags of the channel in a bitfield.
See
https://discord.com/developers/docs/resources/channel#channel-object-channel-flags
Returns
IfPartial<IsPartial, undefined | ChannelFlags>
Inherited from
GuildStageOrVoiceChannel.flags
guild
Get Signature
The guild this channel is in
Returns
IfPartial<IsPartial, Guild<true>>
Inherited from
GuildStageOrVoiceChannel.guild
guildId
Get Signature
get guildId():
IfPartial<IsPartial,string>
The ID of the guild this channel is in
Returns
IfPartial<IsPartial, string>
Inherited from
GuildStageOrVoiceChannel.guildId
name
Get Signature
get name():
IfPartial<IsPartial,string>
The name of the channel.
Returns
IfPartial<IsPartial, string>
Inherited from
nsfw
Get Signature
get nsfw():
IfPartial<IsPartial,boolean>
Whether the channel is marked as nsfw.
Returns
IfPartial<IsPartial, boolean>
Inherited from
parentId
Get Signature
get parentId():
IfPartial<IsPartial,null|string>
The ID of the parent category for the channel.
Returns
IfPartial<IsPartial, null | string>
Inherited from
GuildStageOrVoiceChannel.parentId
partial
Get Signature
get partial():
IsPartial
Whether the channel is a partial channel (meaning it does not have all the data). If this is true, you should use BaseChannel.fetch to get the full data of the channel.
Returns
IsPartial
Inherited from
GuildStageOrVoiceChannel.partial
position
Get Signature
get position():
IfPartial<IsPartial,number>
The position of the channel in the channel list.
Returns
IfPartial<IsPartial, number>
Inherited from
GuildStageOrVoiceChannel.position
rtcRegion
Get Signature
get rtcRegion():
IfPartial<IsPartial,null|string>
The RTC region of the channel.
This is automatic when set to null.
Returns
IfPartial<IsPartial, null | string>
Inherited from
GuildStageOrVoiceChannel.rtcRegion
type
Get Signature
get type():
IfPartial<IsPartial,Type>
The type of the channel.
Returns
IfPartial<IsPartial, Type>
Inherited from
userLimit
Get Signature
get userLimit():
IfPartial<IsPartial,undefined|number>
The user limit of the channel.
Returns
IfPartial<IsPartial, undefined | number>
Inherited from
GuildStageOrVoiceChannel.userLimit
videoQualityMode
Get Signature
get videoQualityMode():
IfPartial<IsPartial,VideoQualityMode>
The video quality mode of the channel. 1 when not present.
Returns
IfPartial<IsPartial, VideoQualityMode>
Inherited from
GuildStageOrVoiceChannel.videoQualityMode
Methods
createInvite()
createInvite(
options?):Promise<APIExtendedInvite>
Create an invite for the channel
Parameters
| Parameter | Type |
|---|---|
options? | RESTPostAPIChannelInviteJSONBody |
Returns
Promise<APIExtendedInvite>
Inherited from
GuildStageOrVoiceChannel.createInvite
fetch()
fetch():
Promise<BaseChannel<GuildVoice,false>>
Fetches the channel from the API.
Returns
Promise<BaseChannel<GuildVoice, false>>
A Promise that resolves to a non-partial channel
Inherited from
GuildStageOrVoiceChannel.fetch
getInvites()
getInvites():
Promise<RESTGetAPIGuildInvitesResult>
Get the invites for the channel
Returns
Promise<RESTGetAPIGuildInvitesResult>
Inherited from
GuildStageOrVoiceChannel.getInvites
send()
send(
message):Promise<void>
Send a message to the channel
Parameters
| Parameter | Type |
|---|---|
message | MessagePayload |
Returns
Promise<void>
Inherited from
setData()
protectedsetData(data):void
Parameters
| Parameter | Type |
|---|---|
data | APIGuildVoiceChannel |
Returns
void
Inherited from
GuildStageOrVoiceChannel.setData
setField()
protectedsetField(field,value):void
Parameters
| Parameter | Type |
|---|---|
field | "guild_id" | "id" | "type" | "name" | "nsfw" | "flags" | "rate_limit_per_user" | "last_message_id" | "permission_overwrites" | "position" | "parent_id" | "bitrate" | "user_limit" | "rtc_region" | "video_quality_mode" |
value | unknown |
Returns
void
Inherited from
GuildStageOrVoiceChannel.setField
setName()
setName(
name):Promise<void>
Set the name of the channel
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The new name of the channel |
Returns
Promise<void>
Inherited from
GuildStageOrVoiceChannel.setName
setNsfw()
setNsfw(
nsfw):Promise<void>
Set whether the channel is nsfw
Parameters
| Parameter | Type | Description |
|---|---|---|
nsfw | boolean | The new nsfw status of the channel |
Returns
Promise<void>
Inherited from
GuildStageOrVoiceChannel.setNsfw
setParent()
setParent(
parent):Promise<void>
Set the parent ID of the channel
Parameters
| Parameter | Type | Description |
|---|---|---|
parent | string | GuildCategoryChannel<false> | The new category channel or ID to set |
Returns
Promise<void>
Inherited from
GuildStageOrVoiceChannel.setParent
setPosition()
setPosition(
position):Promise<void>
Set the position of the channel
Parameters
| Parameter | Type | Description |
|---|---|---|
position | number | The new position of the channel |
Returns
Promise<void>
Inherited from
GuildStageOrVoiceChannel.setPosition
triggerTyping()
triggerTyping():
Promise<void>
Trigger a typing indicator in the channel (this will expire after 10 seconds)
Returns
Promise<void>