Skip to content

Commit 9907ff9

Browse files
imnaiyaralmeidxkodiakhq[bot]
authoredAug 20, 2024··
feat(VoiceState): add methods for fetching voice state (#10442)
* feat(VoiceState): add methods for fetching voice state * fix: links to new methods * chore: remove unused import * chore: use member id * chore: requested changes * chore: '@me' as fetch param * chore: add ediUserVoiceState return type * refactor: redirect function calls to VoiceAPI --------- Co-authored-by: Almeida <almeidx@pm.me> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
·
@discordjs/ws@2.0.114.16.0
1 parent 9b707f2 commit 9907ff9

File tree

6 files changed

+125
-12
lines changed

6 files changed

+125
-12
lines changed
 

‎packages/core/src/api/guild.ts

+14-9
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ import {
6767
type RESTPatchAPIGuildTemplateJSONBody,
6868
type RESTPatchAPIGuildTemplateResult,
6969
type RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody,
70-
type RESTPatchAPIGuildVoiceStateCurrentMemberResult,
7170
type RESTPatchAPIGuildVoiceStateUserJSONBody,
7271
type RESTPatchAPIGuildWelcomeScreenJSONBody,
7372
type RESTPatchAPIGuildWelcomeScreenResult,
@@ -102,6 +101,7 @@ import {
102101
type RESTPutAPIGuildTemplateSyncResult,
103102
type Snowflake,
104103
} from 'discord-api-types/v10';
104+
import { VoiceAPI } from './voice';
105105

106106
export class GuildsAPI {
107107
public constructor(private readonly rest: REST) {}
@@ -687,19 +687,20 @@ export class GuildsAPI {
687687
/**
688688
* Edits a user's voice state in a guild
689689
*
690-
* @see {@link https://discord.com/developers/docs/resources/guild#modify-user-voice-state}
690+
* @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state}
691691
* @param guildId - The id of the guild to edit the current user's voice state in
692692
* @param userId - The id of the user to edit the voice state for
693693
* @param body - The data for editing the voice state
694694
* @param options - The options for editing the voice state
695+
* @deprecated Use {@link VoiceAPI.editUserVoiceState} instead
695696
*/
696697
public async editUserVoiceState(
697698
guildId: Snowflake,
698699
userId: Snowflake,
699700
body: RESTPatchAPIGuildVoiceStateUserJSONBody,
700701
{ reason, signal }: Pick<RequestData, 'reason' | 'signal'> = {},
701702
) {
702-
await this.rest.patch(Routes.guildVoiceState(guildId, userId), { reason, body, signal });
703+
return new VoiceAPI(this.rest).editUserVoiceState(guildId, userId, body, { reason, signal });
703704
}
704705

705706
/**
@@ -1298,14 +1299,18 @@ export class GuildsAPI {
12981299
/**
12991300
* Sets the voice state for the current user
13001301
*
1301-
* @see {@link https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state}
1302+
* @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state}
13021303
* @param guildId - The id of the guild
1303-
* @param body - The options for setting the voice state
1304+
* @param body - The data for setting the voice state
1305+
* @param options - The options for setting the voice state
1306+
* @deprecated Use {@link VoiceAPI.editVoiceState} instead
13041307
*/
1305-
public async setVoiceState(guildId: Snowflake, body: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody = {}) {
1306-
return this.rest.patch(Routes.guildVoiceState(guildId, '@me'), {
1307-
body,
1308-
}) as Promise<RESTPatchAPIGuildVoiceStateCurrentMemberResult>;
1308+
public async setVoiceState(
1309+
guildId: Snowflake,
1310+
body: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody = {},
1311+
{ signal }: Pick<RequestData, 'signal'> = {},
1312+
) {
1313+
return new VoiceAPI(this.rest).editVoiceState(guildId, body, { signal });
13091314
}
13101315

13111316
/**

‎packages/core/src/api/voice.ts

+76-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
/* eslint-disable jsdoc/check-param-names */
22

33
import type { RequestData, REST } from '@discordjs/rest';
4-
import { Routes, type RESTGetAPIVoiceRegionsResult } from 'discord-api-types/v10';
4+
import {
5+
Routes,
6+
type Snowflake,
7+
type RESTGetAPIVoiceRegionsResult,
8+
type RESTGetAPIGuildVoiceStateUserResult,
9+
type RESTGetAPIGuildVoiceStateCurrentMemberResult,
10+
type RESTPatchAPIGuildVoiceStateUserJSONBody,
11+
type RESTPatchAPIGuildVoiceStateCurrentMemberResult,
12+
type RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody,
13+
type RESTPatchAPIGuildVoiceStateUserResult,
14+
} from 'discord-api-types/v10';
515

616
export class VoiceAPI {
717
public constructor(private readonly rest: REST) {}
@@ -15,4 +25,69 @@ export class VoiceAPI {
1525
public async getVoiceRegions({ signal }: Pick<RequestData, 'signal'> = {}) {
1626
return this.rest.get(Routes.voiceRegions(), { signal }) as Promise<RESTGetAPIVoiceRegionsResult>;
1727
}
28+
29+
/**
30+
* Fetches voice state of a user by their id
31+
*
32+
* @see {@link https://discord.com/developers/docs/resources/voice#get-user-voice-state}
33+
* @param options - The options for fetching user voice state
34+
*/
35+
public async getUserVoiceState(guildId: Snowflake, userId: Snowflake, { signal }: Pick<RequestData, 'signal'> = {}) {
36+
return this.rest.get(Routes.guildVoiceState(guildId, userId), {
37+
signal,
38+
}) as Promise<RESTGetAPIGuildVoiceStateUserResult>;
39+
}
40+
41+
/**
42+
* Fetches the current user's voice state
43+
*
44+
* @see {@link https://discord.com/developers/docs/resources/voice#get-current-user-voice-state}
45+
* @param options - The options for fetching user voice state
46+
*/
47+
public async getVoiceState(guildId: Snowflake, { signal }: Pick<RequestData, 'signal'> = {}) {
48+
return this.rest.get(Routes.guildVoiceState(guildId, '@me'), {
49+
signal,
50+
}) as Promise<RESTGetAPIGuildVoiceStateCurrentMemberResult>;
51+
}
52+
53+
/**
54+
* Edits a user's voice state in a guild
55+
*
56+
* @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state}
57+
* @param guildId - The id of the guild to edit the current user's voice state in
58+
* @param userId - The id of the user to edit the voice state for
59+
* @param body - The data for editing the voice state
60+
* @param options - The options for editing the voice state
61+
*/
62+
public async editUserVoiceState(
63+
guildId: Snowflake,
64+
userId: Snowflake,
65+
body: RESTPatchAPIGuildVoiceStateUserJSONBody,
66+
{ reason, signal }: Pick<RequestData, 'reason' | 'signal'> = {},
67+
) {
68+
return this.rest.patch(Routes.guildVoiceState(guildId, userId), {
69+
reason,
70+
body,
71+
signal,
72+
}) as Promise<RESTPatchAPIGuildVoiceStateUserResult>;
73+
}
74+
75+
/**
76+
* Edits the voice state for the current user
77+
*
78+
* @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state}
79+
* @param guildId - The id of the guild
80+
* @param body - The data for editing the voice state
81+
* @param options - The options for editing the voice state
82+
*/
83+
public async editVoiceState(
84+
guildId: Snowflake,
85+
body: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody = {},
86+
{ signal }: Pick<RequestData, 'signal'> = {},
87+
) {
88+
return this.rest.patch(Routes.guildVoiceState(guildId, '@me'), {
89+
body,
90+
signal,
91+
}) as Promise<RESTPatchAPIGuildVoiceStateCurrentMemberResult>;
92+
}
1893
}

‎packages/discord.js/src/managers/VoiceStateManager.js

+22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
'use strict';
22

3+
const { Routes } = require('discord-api-types/v10');
34
const CachedManager = require('./CachedManager');
45
const VoiceState = require('../structures/VoiceState');
56

@@ -32,6 +33,27 @@ class VoiceStateManager extends CachedManager {
3233
if (cache) this.cache.set(data.user_id, entry);
3334
return entry;
3435
}
36+
37+
/**
38+
* Obtains a user's voice state from discord or from the cache if it's already available.
39+
* @param {GuildMemberResolvable|'@me'} member The member whose voice state is to be fetched
40+
* @param {BaseFetchOptions} [options] Additional options for this fetch
41+
* @returns {Promise<VoiceState>}
42+
* @example
43+
* // Fetch a member's voice state
44+
* guild.voiceStates.fetch("66564597481480192")
45+
* .then(console.log)
46+
* .catch(console.error);
47+
*/
48+
async fetch(member, { cache = true, force = false } = {}) {
49+
const id = member === '@me' ? member : this.guild.members.resolveId(member);
50+
if (!force) {
51+
const existing = this.cache.get(id === '@me' ? this.client.user.id : id);
52+
if (existing) return existing;
53+
}
54+
const data = await this.client.rest.get(Routes.guildVoiceState(this.guild.id, id));
55+
return this._add(data, cache);
56+
}
3557
}
3658

3759
module.exports = VoiceStateManager;

‎packages/discord.js/src/structures/VoiceState.js

+9
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,15 @@ class VoiceState extends Base {
250250
return this;
251251
}
252252

253+
/**
254+
* Fetches this voice state.
255+
* @param {boolean} [force=true] Whether to skip the cache check and request the API
256+
* @returns {Promise<VoiceState>}
257+
*/
258+
fetch(force = true) {
259+
return this.guild.voiceStates.fetch(this.id, { force });
260+
}
261+
253262
/**
254263
* Toggles the request to speak in the channel.
255264
* Only applicable for stage channels and for the client's own voice state.

‎packages/discord.js/typings/index.d.ts

+2
Original file line numberDiff line numberDiff line change
@@ -3625,6 +3625,7 @@ export class VoiceState extends Base {
36253625
public setRequestToSpeak(request?: boolean): Promise<this>;
36263626
public setSuppressed(suppressed?: boolean): Promise<this>;
36273627
public edit(options: VoiceStateEditOptions): Promise<this>;
3628+
public fetch(force?: boolean): Promise<VoiceState>;
36283629
}
36293630

36303631
// tslint:disable-next-line no-empty-interface
@@ -4627,6 +4628,7 @@ export class UserManager extends CachedManager<Snowflake, User, UserResolvable>
46274628
export class VoiceStateManager extends CachedManager<Snowflake, VoiceState, typeof VoiceState> {
46284629
private constructor(guild: Guild, iterable?: Iterable<RawVoiceStateData>);
46294630
public guild: Guild;
4631+
public fetch(member: GuildMemberResolvable | '@me', options?: BaseFetchOptions): Promise<VoiceState>;
46304632
}
46314633

46324634
//#endregion

‎packages/discord.js/typings/rawDataTypes.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ import {
4747
APIUnavailableGuild,
4848
APIUser,
4949
APIVoiceRegion,
50+
APIVoiceState,
5051
APIWebhook,
5152
GatewayActivity,
5253
GatewayActivityAssets,
@@ -62,7 +63,6 @@ import {
6263
GatewayPresenceUpdate,
6364
GatewayReadyDispatchData,
6465
GatewayTypingStartDispatchData,
65-
GatewayVoiceState,
6666
RESTAPIPartialCurrentUserGuild,
6767
RESTGetAPIWebhookWithTokenResult,
6868
RESTPatchAPIChannelMessageJSONBody,
@@ -195,7 +195,7 @@ export type RawUserData =
195195

196196
export type RawVoiceRegionData = APIVoiceRegion;
197197

198-
export type RawVoiceStateData = GatewayVoiceState | Omit<GatewayVoiceState, 'guild_id'>;
198+
export type RawVoiceStateData = APIVoiceState | Omit<APIVoiceState, 'guild_id'>;
199199

200200
export type RawWebhookData =
201201
| APIWebhook

0 commit comments

Comments
 (0)
Please sign in to comment.