summaryrefslogtreecommitdiff
path: root/node_modules/discord.js/src/structures/VoiceState.js
diff options
context:
space:
mode:
authorsowgro <tpoke.ferrari@gmail.com>2023-09-02 19:12:47 -0400
committersowgro <tpoke.ferrari@gmail.com>2023-09-02 19:12:47 -0400
commite4450c8417624b71d779cb4f41692538f9165e10 (patch)
treeb70826542223ecdf8a7a259f61b0a1abb8a217d8 /node_modules/discord.js/src/structures/VoiceState.js
downloadsowbot3-e4450c8417624b71d779cb4f41692538f9165e10.tar.gz
sowbot3-e4450c8417624b71d779cb4f41692538f9165e10.tar.bz2
sowbot3-e4450c8417624b71d779cb4f41692538f9165e10.zip
first commit
Diffstat (limited to 'node_modules/discord.js/src/structures/VoiceState.js')
-rw-r--r--node_modules/discord.js/src/structures/VoiceState.js303
1 files changed, 303 insertions, 0 deletions
diff --git a/node_modules/discord.js/src/structures/VoiceState.js b/node_modules/discord.js/src/structures/VoiceState.js
new file mode 100644
index 0000000..ae510f2
--- /dev/null
+++ b/node_modules/discord.js/src/structures/VoiceState.js
@@ -0,0 +1,303 @@
+'use strict';
+
+const { ChannelType, Routes } = require('discord-api-types/v10');
+const Base = require('./Base');
+const { DiscordjsError, DiscordjsTypeError, ErrorCodes } = require('../errors');
+
+/**
+ * Represents the voice state for a Guild Member.
+ * @extends {Base}
+ */
+class VoiceState extends Base {
+ constructor(guild, data) {
+ super(guild.client);
+ /**
+ * The guild of this voice state
+ * @type {Guild}
+ */
+ this.guild = guild;
+ /**
+ * The id of the member of this voice state
+ * @type {Snowflake}
+ */
+ this.id = data.user_id;
+ this._patch(data);
+ }
+
+ _patch(data) {
+ if ('deaf' in data) {
+ /**
+ * Whether this member is deafened server-wide
+ * @type {?boolean}
+ */
+ this.serverDeaf = data.deaf;
+ } else {
+ this.serverDeaf ??= null;
+ }
+
+ if ('mute' in data) {
+ /**
+ * Whether this member is muted server-wide
+ * @type {?boolean}
+ */
+ this.serverMute = data.mute;
+ } else {
+ this.serverMute ??= null;
+ }
+
+ if ('self_deaf' in data) {
+ /**
+ * Whether this member is self-deafened
+ * @type {?boolean}
+ */
+ this.selfDeaf = data.self_deaf;
+ } else {
+ this.selfDeaf ??= null;
+ }
+
+ if ('self_mute' in data) {
+ /**
+ * Whether this member is self-muted
+ * @type {?boolean}
+ */
+ this.selfMute = data.self_mute;
+ } else {
+ this.selfMute ??= null;
+ }
+
+ if ('self_video' in data) {
+ /**
+ * Whether this member's camera is enabled
+ * @type {?boolean}
+ */
+ this.selfVideo = data.self_video;
+ } else {
+ this.selfVideo ??= null;
+ }
+
+ if ('session_id' in data) {
+ /**
+ * The session id for this member's connection
+ * @type {?string}
+ */
+ this.sessionId = data.session_id;
+ } else {
+ this.sessionId ??= null;
+ }
+
+ // The self_stream is property is omitted if false, check for another property
+ // here to avoid incorrectly clearing this when partial data is specified
+ if ('self_video' in data) {
+ /**
+ * Whether this member is streaming using "Screen Share"
+ * @type {?boolean}
+ */
+ this.streaming = data.self_stream ?? false;
+ } else {
+ this.streaming ??= null;
+ }
+
+ if ('channel_id' in data) {
+ /**
+ * The {@link VoiceChannel} or {@link StageChannel} id the member is in
+ * @type {?Snowflake}
+ */
+ this.channelId = data.channel_id;
+ } else {
+ this.channelId ??= null;
+ }
+
+ if ('suppress' in data) {
+ /**
+ * Whether this member is suppressed from speaking. This property is specific to stage channels only.
+ * @type {?boolean}
+ */
+ this.suppress = data.suppress;
+ } else {
+ this.suppress ??= null;
+ }
+
+ if ('request_to_speak_timestamp' in data) {
+ /**
+ * The time at which the member requested to speak. This property is specific to stage channels only.
+ * @type {?number}
+ */
+ this.requestToSpeakTimestamp = data.request_to_speak_timestamp && Date.parse(data.request_to_speak_timestamp);
+ } else {
+ this.requestToSpeakTimestamp ??= null;
+ }
+
+ return this;
+ }
+
+ /**
+ * The member that this voice state belongs to
+ * @type {?GuildMember}
+ * @readonly
+ */
+ get member() {
+ return this.guild.members.cache.get(this.id) ?? null;
+ }
+
+ /**
+ * The channel that the member is connected to
+ * @type {?(VoiceChannel|StageChannel)}
+ * @readonly
+ */
+ get channel() {
+ return this.guild.channels.cache.get(this.channelId) ?? null;
+ }
+
+ /**
+ * Whether this member is either self-deafened or server-deafened
+ * @type {?boolean}
+ * @readonly
+ */
+ get deaf() {
+ return this.serverDeaf || this.selfDeaf;
+ }
+
+ /**
+ * Whether this member is either self-muted or server-muted
+ * @type {?boolean}
+ * @readonly
+ */
+ get mute() {
+ return this.serverMute || this.selfMute;
+ }
+
+ /**
+ * Mutes/unmutes the member of this voice state.
+ * @param {boolean} [mute=true] Whether or not the member should be muted
+ * @param {string} [reason] Reason for muting or unmuting
+ * @returns {Promise<GuildMember>}
+ */
+ setMute(mute = true, reason) {
+ return this.guild.members.edit(this.id, { mute, reason });
+ }
+
+ /**
+ * Deafens/undeafens the member of this voice state.
+ * @param {boolean} [deaf=true] Whether or not the member should be deafened
+ * @param {string} [reason] Reason for deafening or undeafening
+ * @returns {Promise<GuildMember>}
+ */
+ setDeaf(deaf = true, reason) {
+ return this.guild.members.edit(this.id, { deaf, reason });
+ }
+
+ /**
+ * Disconnects the member from the channel.
+ * @param {string} [reason] Reason for disconnecting the member from the channel
+ * @returns {Promise<GuildMember>}
+ */
+ disconnect(reason) {
+ return this.setChannel(null, reason);
+ }
+
+ /**
+ * Moves the member to a different channel, or disconnects them from the one they're in.
+ * @param {GuildVoiceChannelResolvable|null} channel Channel to move the member to, or `null` if you want to
+ * disconnect them from voice.
+ * @param {string} [reason] Reason for moving member to another channel or disconnecting
+ * @returns {Promise<GuildMember>}
+ */
+ setChannel(channel, reason) {
+ return this.guild.members.edit(this.id, { channel, reason });
+ }
+
+ /**
+ * Data to edit the logged in user's own voice state with, when in a stage channel
+ * @typedef {Object} VoiceStateEditOptions
+ * @property {boolean} [requestToSpeak] Whether or not the client is requesting to become a speaker.
+ * <info>Only available to the logged in user's own voice state.</info>
+ * @property {boolean} [suppressed] Whether or not the user should be suppressed.
+ */
+
+ /**
+ * Edits this voice state. Currently only available when in a stage channel
+ * @param {VoiceStateEditOptions} options The options to provide
+ * @returns {Promise<VoiceState>}
+ */
+ async edit(options) {
+ if (this.channel?.type !== ChannelType.GuildStageVoice) throw new DiscordjsError(ErrorCodes.VoiceNotStageChannel);
+
+ const target = this.client.user.id === this.id ? '@me' : this.id;
+
+ if (target !== '@me' && options.requestToSpeak !== undefined) {
+ throw new DiscordjsError(ErrorCodes.VoiceStateNotOwn);
+ }
+
+ if (!['boolean', 'undefined'].includes(typeof options.requestToSpeak)) {
+ throw new DiscordjsTypeError(ErrorCodes.VoiceStateInvalidType, 'requestToSpeak');
+ }
+
+ if (!['boolean', 'undefined'].includes(typeof options.suppressed)) {
+ throw new DiscordjsTypeError(ErrorCodes.VoiceStateInvalidType, 'suppressed');
+ }
+
+ await this.client.rest.patch(Routes.guildVoiceState(this.guild.id, target), {
+ body: {
+ channel_id: this.channelId,
+ request_to_speak_timestamp: options.requestToSpeak
+ ? new Date().toISOString()
+ : options.requestToSpeak === false
+ ? null
+ : undefined,
+ suppress: options.suppressed,
+ },
+ });
+ return this;
+ }
+
+ /**
+ * Toggles the request to speak in the channel.
+ * Only applicable for stage channels and for the client's own voice state.
+ * @param {boolean} [requestToSpeak=true] Whether or not the client is requesting to become a speaker.
+ * @example
+ * // Making the client request to speak in a stage channel (raise its hand)
+ * guild.members.me.voice.setRequestToSpeak(true);
+ * @example
+ * // Making the client cancel a request to speak
+ * guild.members.me.voice.setRequestToSpeak(false);
+ * @returns {Promise<VoiceState>}
+ */
+ setRequestToSpeak(requestToSpeak = true) {
+ return this.edit({ requestToSpeak });
+ }
+
+ /**
+ * Suppress/unsuppress the user. Only applicable for stage channels.
+ * @param {boolean} [suppressed=true] Whether or not the user should be suppressed.
+ * @example
+ * // Making the client a speaker
+ * guild.members.me.voice.setSuppressed(false);
+ * @example
+ * // Making the client an audience member
+ * guild.members.me.voice.setSuppressed(true);
+ * @example
+ * // Inviting another user to speak
+ * voiceState.setSuppressed(false);
+ * @example
+ * // Moving another user to the audience, or cancelling their invite to speak
+ * voiceState.setSuppressed(true);
+ * @returns {Promise<VoiceState>}
+ */
+ setSuppressed(suppressed = true) {
+ return this.edit({ suppressed });
+ }
+
+ toJSON() {
+ return super.toJSON({
+ id: true,
+ serverDeaf: true,
+ serverMute: true,
+ selfDeaf: true,
+ selfMute: true,
+ sessionId: true,
+ channelId: 'channel',
+ });
+ }
+}
+
+module.exports = VoiceState;