mirror of
https://github.com/discordjs/discord.js.git
synced 2026-06-02 09:00:07 +00:00
9907ff915e
* 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>
94 lines
3.2 KiB
TypeScript
94 lines
3.2 KiB
TypeScript
/* eslint-disable jsdoc/check-param-names */
|
|
|
|
import type { RequestData, REST } from '@discordjs/rest';
|
|
import {
|
|
Routes,
|
|
type Snowflake,
|
|
type RESTGetAPIVoiceRegionsResult,
|
|
type RESTGetAPIGuildVoiceStateUserResult,
|
|
type RESTGetAPIGuildVoiceStateCurrentMemberResult,
|
|
type RESTPatchAPIGuildVoiceStateUserJSONBody,
|
|
type RESTPatchAPIGuildVoiceStateCurrentMemberResult,
|
|
type RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody,
|
|
type RESTPatchAPIGuildVoiceStateUserResult,
|
|
} from 'discord-api-types/v10';
|
|
|
|
export class VoiceAPI {
|
|
public constructor(private readonly rest: REST) {}
|
|
|
|
/**
|
|
* Fetches all voice regions
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/voice#list-voice-regions}
|
|
* @param options - The options for fetching the voice regions
|
|
*/
|
|
public async getVoiceRegions({ signal }: Pick<RequestData, 'signal'> = {}) {
|
|
return this.rest.get(Routes.voiceRegions(), { signal }) as Promise<RESTGetAPIVoiceRegionsResult>;
|
|
}
|
|
|
|
/**
|
|
* Fetches voice state of a user by their id
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/voice#get-user-voice-state}
|
|
* @param options - The options for fetching user voice state
|
|
*/
|
|
public async getUserVoiceState(guildId: Snowflake, userId: Snowflake, { signal }: Pick<RequestData, 'signal'> = {}) {
|
|
return this.rest.get(Routes.guildVoiceState(guildId, userId), {
|
|
signal,
|
|
}) as Promise<RESTGetAPIGuildVoiceStateUserResult>;
|
|
}
|
|
|
|
/**
|
|
* Fetches the current user's voice state
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/voice#get-current-user-voice-state}
|
|
* @param options - The options for fetching user voice state
|
|
*/
|
|
public async getVoiceState(guildId: Snowflake, { signal }: Pick<RequestData, 'signal'> = {}) {
|
|
return this.rest.get(Routes.guildVoiceState(guildId, '@me'), {
|
|
signal,
|
|
}) as Promise<RESTGetAPIGuildVoiceStateCurrentMemberResult>;
|
|
}
|
|
|
|
/**
|
|
* Edits a user's voice state in a guild
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state}
|
|
* @param guildId - The id of the guild to edit the current user's voice state in
|
|
* @param userId - The id of the user to edit the voice state for
|
|
* @param body - The data for editing the voice state
|
|
* @param options - The options for editing the voice state
|
|
*/
|
|
public async editUserVoiceState(
|
|
guildId: Snowflake,
|
|
userId: Snowflake,
|
|
body: RESTPatchAPIGuildVoiceStateUserJSONBody,
|
|
{ reason, signal }: Pick<RequestData, 'reason' | 'signal'> = {},
|
|
) {
|
|
return this.rest.patch(Routes.guildVoiceState(guildId, userId), {
|
|
reason,
|
|
body,
|
|
signal,
|
|
}) as Promise<RESTPatchAPIGuildVoiceStateUserResult>;
|
|
}
|
|
|
|
/**
|
|
* Edits the voice state for the current user
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state}
|
|
* @param guildId - The id of the guild
|
|
* @param body - The data for editing the voice state
|
|
* @param options - The options for editing the voice state
|
|
*/
|
|
public async editVoiceState(
|
|
guildId: Snowflake,
|
|
body: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody = {},
|
|
{ signal }: Pick<RequestData, 'signal'> = {},
|
|
) {
|
|
return this.rest.patch(Routes.guildVoiceState(guildId, '@me'), {
|
|
body,
|
|
signal,
|
|
}) as Promise<RESTPatchAPIGuildVoiceStateCurrentMemberResult>;
|
|
}
|
|
}
|