VoiceChannel
VoiceChannel ⇐ VoiceBasedChannels
Represents a voice channel in a guild.
Kind: global class
Extends: VoiceBasedChannels
- VoiceChannel ⇐
VoiceBasedChannels
- new VoiceChannel([data], guildId, client)
- .messages ⇒
MessageManager
- .send(options) ⇒
Promise
- .bulkDelete(messages, reason) ⇒
Promise.<void>
- .setNsfw(nsfw, reason) ⇒
Promise
- .setRateLimitPerUser(ratelimit, reason) ⇒
Promise
- .setUserLimit(userLimit, reason) ⇒
Promise
- .setVideoQualityMode(videoQualityMode, reason) ⇒
Promise
- .triggerTyping() ⇒
Promise.<void>
new VoiceChannel([data], guildId, client)
Constructs a new instance of the class.
Param | Type | Description |
---|---|---|
[data] | Object | The data object containing the properties for the instance. |
guildId | string | The ID of the guild associated with the instance. |
client | Client | The client object associated with the instance. |
voiceChannel.messages ⇒ MessageManager
Get the message manager for this channel.
Kind: instance property of VoiceChannel
Returns: MessageManager
- The message manager object for this channel.
voiceChannel.send(options) ⇒ Promise
Sends a message using the specified options.
Kind: instance method of VoiceChannel
Returns: Promise
- A promise that resolves when the message is sent.
Param | Type | Description |
---|---|---|
options | object | The options for sending the message. |
voiceChannel.bulkDelete(messages, reason) ⇒ Promise.<void>
Bulk deletes the specified messages with the given reason.
Kind: instance method of VoiceChannel
Returns: Promise.<void>
- A promise that resolves when the messages are deleted.
Param | Type | Description |
---|---|---|
messages | Array.<Message> | The messages to be deleted. |
reason | string | The reason for deleting the messages. |
voiceChannel.setNsfw(nsfw, reason) ⇒ Promise
Sets the NSFW (Not Safe for Work) flag for the current item.
Kind: instance method of VoiceChannel
Returns: Promise
- - A promise that resolves when the NSFW flag is set.
Param | Type | Description |
---|---|---|
nsfw | boolean | The NSFW flag value to set. |
reason | string | The reason for setting the NSFW flag. |
voiceChannel.setRateLimitPerUser(ratelimit, reason) ⇒ Promise
Sets the rate limit per user for a specific action.
Kind: instance method of VoiceChannel
Returns: Promise
- - A promise that resolves when the rate limit is successfully set.
Param | Type | Description |
---|---|---|
ratelimit | number | The new rate limit value to set. |
reason | string | The reason for setting the rate limit. |
voiceChannel.setUserLimit(userLimit, reason) ⇒ Promise
Sets the user limit for the current channel and provides a reason for the change.
Kind: instance method of VoiceChannel
Returns: Promise
- - A promise that resolves when the user limit is successfully set.
Param | Type | Description |
---|---|---|
userLimit | number | The new user limit for the channel. |
reason | string | The reason for changing the user limit. |
voiceChannel.setVideoQualityMode(videoQualityMode, reason) ⇒ Promise
Sets the video quality mode with the given parameters.
Kind: instance method of VoiceChannel
Returns: Promise
- - A promise that resolves when the video quality mode is set.
Param | Type | Description |
---|---|---|
videoQualityMode | string | The video quality mode to set. |
reason | string | The reason for setting the video quality mode. |
voiceChannel.triggerTyping() ⇒ Promise.<void>
Triggers a typing indicator in the channel where this method is called.
Kind: instance method of VoiceChannel
Returns: Promise.<void>
- - A promise that resolves when the typing indicator is triggered.