StageChannel
Extends
ObjectToLower
<Omit
<APIGuildStageVoiceChannel
,"type"
>>.TopicableGuildChannel
.VoiceChannelMethods
.BaseChannel
<ChannelType
>
Constructors
new StageChannel(client, data)
1new StageChannel(client: UsingClient, data: APIChannelBase<ChannelType>): StageChannel
Parameters
Parameter | Type |
---|---|
client | UsingClient |
data | APIChannelBase <ChannelType > |
Returns
Inherited from
Source
seyfert/src/structures/channels.ts:47
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
bitrate | public | undefined | number | ObjectToLower.bitrate |
client | readonly | UsingClient | BaseChannel .client |
flags | public | undefined | ChannelFlags | ObjectToLower.flags |
guildId | public | undefined | string | VoiceChannelMethods .guildId |
id | public | string | BaseChannel .id |
lastMessageId | public | undefined | null | string | ObjectToLower.lastMessageId |
name | public | string | ObjectToLower.name |
nsfw | public | undefined | boolean | ObjectToLower.nsfw |
parentId | public | undefined | null | string | ObjectToLower.parentId |
permissionOverwrites | public | undefined | Object [] | ObjectToLower.permissionOverwrites |
position | public | number | ObjectToLower.position |
rateLimitPerUser | public | undefined | number | ObjectToLower.rateLimitPerUser |
rtcRegion | public | undefined | null | string | ObjectToLower.rtcRegion |
type | public | GuildStageVoice | BaseChannel .type |
userLimit | public | undefined | number | ObjectToLower.userLimit |
videoQualityMode | public | undefined | VideoQualityMode | ObjectToLower.videoQualityMode |
Accessors
createdAt
1get createdAt(): Date
createdAt gets the creation Date instace of the current object.
Returns
Date
Source
seyfert/src/structures/extra/DiscordBase.ts:27
createdTimestamp
1get createdTimestamp(): number
Create a timestamp for the current object.
Returns
number
Source
seyfert/src/structures/extra/DiscordBase.ts:20
url
1get url(): string
The URL to the channel
Returns
string
Source
seyfert/src/structures/channels.ts:58
Methods
delete()
1delete(reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:66
edit()
1edit(body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
body | RESTPatchAPIChannelJSONBody |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:70
fetch()
1fetch(force: boolean): Promise<AllChannels>
Parameters
Parameter | Type | Default value |
---|---|---|
force | boolean | false |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:62
is()
1is<T>(channelTypes: T): this is IChannelTypes[T[number]]
Type parameters
Type parameter |
---|
T extends keyof IChannelTypes [] |
Parameters
Parameter | Type |
---|---|
channelTypes | T |
Returns
this is IChannelTypes[T[number]]
Inherited from
Source
seyfert/src/structures/channels.ts:133
isCategory()
1isCategory(): this is CategoryChannel
Returns
this is CategoryChannel
Inherited from
Source
seyfert/src/structures/channels.ts:113
isDM()
1isDM(): this is DMChannel
Returns
this is DMChannel
Inherited from
Source
seyfert/src/structures/channels.ts:89
isDirectory()
1isDirectory(): this is DirectoryChannel
Returns
this is DirectoryChannel
Inherited from
Source
seyfert/src/structures/channels.ts:101
isForum()
1isForum(): this is ForumChannel
Returns
this is ForumChannel
Inherited from
Source
seyfert/src/structures/channels.ts:93
isGuildTextable()
1isGuildTextable(): this is AllGuildTextableChannels
Returns
this is AllGuildTextableChannels
Inherited from
Source
seyfert/src/structures/channels.ts:125
isMedia()
1isMedia(): this is MediaChannel
Returns
this is MediaChannel
Inherited from
Source
seyfert/src/structures/channels.ts:85
isNews()
1isNews(): this is NewsChannel
Returns
this is NewsChannel
Inherited from
Source
seyfert/src/structures/channels.ts:117
isStage()
1isStage(): this is StageChannel
Returns
this is StageChannel
Inherited from
Source
seyfert/src/structures/channels.ts:81
isTextGuild()
1isTextGuild(): this is TextGuildChannel
Returns
this is TextGuildChannel
Inherited from
Source
seyfert/src/structures/channels.ts:109
isTextable()
1isTextable(): this is AllTextableChannels
Returns
this is AllTextableChannels
Inherited from
Source
seyfert/src/structures/channels.ts:121
isThread()
1isThread(): this is ThreadChannel
Returns
this is ThreadChannel
Inherited from
Source
seyfert/src/structures/channels.ts:97
isThreadOnly()
1isThreadOnly(): this is MediaChannel | ForumChannel
Returns
this is MediaChannel | ForumChannel
Inherited from
Source
seyfert/src/structures/channels.ts:129
isVoice()
1isVoice(): this is VoiceChannel
Returns
this is VoiceChannel
Inherited from
Source
seyfert/src/structures/channels.ts:105
setBitrate()
1setBitrate(bitrate: null | number, reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
bitrate | null | number |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
VoiceChannelMethods
.setBitrate
Source
seyfert/src/structures/channels.ts:342
setRTC()
1setRTC(rtc_region: null | string, reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
rtc_region | null | string |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:350
setTopic()
1setTopic(topic: null | string, reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
topic | null | string |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
TopicableGuildChannel
.setTopic
Source
seyfert/src/structures/channels.ts:306
setUserLimit()
1setUserLimit(user_limit: null | number, reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
user_limit | null | number |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
VoiceChannelMethods
.setUserLimit
Source
seyfert/src/structures/channels.ts:346
setVideoQuality()
1setVideoQuality(quality: "Auto" | "Full", reason?: string): Promise<AllChannels>
Parameters
Parameter | Type |
---|---|
quality | "Auto" | "Full" |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
VoiceChannelMethods
.setVideoQuality
Source
seyfert/src/structures/channels.ts:354
setVoiceState()
1setVoiceState(status: null | string): Promise<never>
Parameters
Parameter | Type | Default value |
---|---|---|
status | null | string | null |
Returns
Promise
<never
>
Inherited from
VoiceChannelMethods
.setVoiceState
Source
seyfert/src/structures/channels.ts:358
states()
1states(): Promise<VoiceState[]>
Returns
Promise
<VoiceState
[]>
Inherited from
Source
seyfert/src/structures/channels.ts:362
toString()
1toString(): string
Returns
string
Inherited from
Source
seyfert/src/structures/channels.ts:77
__intent__()
__intent__(id)
1static __intent__(id: "@me"): "DirectMessages"
Parameters
Parameter | Type |
---|---|
id | "@me" |
Returns
"DirectMessages"
Inherited from
Source
seyfert/src/structures/channels.ts:51
__intent__(id)
1static __intent__(id: string): "DirectMessages" | "Guilds"
Parameters
Parameter | Type |
---|---|
id | string |
Returns
"DirectMessages"
| "Guilds"
Inherited from
Source
seyfert/src/structures/channels.ts:52
allMethods()
1static allMethods(ctx: Object): Object
Parameters
Parameter | Type |
---|---|
ctx | Object |
ctx.client | UsingClient |
ctx.guildId | string |
Returns
Object
Member | Type | Value |
---|---|---|
create | (body : RESTPostAPIGuildChannelJSONBody ) => Promise <AllChannels > | - |
delete | (id : string , reason ?: string ) => Promise <AllChannels > | - |
edit | (id : string , body : RESTPatchAPIChannelJSONBody , reason ?: string ) => Promise <AllChannels > | - |
editPositions | (body : RESTPatchAPIGuildChannelPositionsJSONBody ) => Promise <never > | - |
fetch | (id : string , force : boolean ) => Promise <AllChannels > | - |
list | (force : boolean ) => Promise <AllChannels []> | - |