VoiceAPI

export declare class VoiceAPI
export declare class VoiceAPI

No summary provided.

constructor(rest)
Constructs a new instance of the VoiceAPI class
NameTypeOptionalDescription
restRESTNoNone
editUserVoiceState(guildId, userId, body, options?):Promise<never>
NameTypeOptionalDescription
guildIdSnowflakeNo
The id of the guild to edit the current user's voice state in
userIdSnowflakeNo
The id of the user to edit the voice state for
bodyRESTPatchAPIGuildVoiceStateUserJSONBodyNo
The data for editing the voice state
optionsPick<RequestData, 'auth' | 'reason' | 'signal'>Yes
The options for editing the voice state
editVoiceState(guildId, body?, options?):Promise<never>
NameTypeOptionalDescription
guildIdSnowflakeNo
The id of the guild
bodyRESTPatchAPIGuildVoiceStateCurrentMemberJSONBodyYes
The data for editing the voice state
optionsPick<RequestData, 'auth' | 'signal'>Yes
The options for editing the voice state
getUserVoiceState(options, userId, { auth, signal }?):Promise<APIVoiceState>
Fetches voice state of a user by their id
NameTypeOptionalDescription
optionsSnowflakeNo
The options for fetching user voice state
userIdSnowflakeNoNone
{ auth, signal }Pick<RequestData, 'auth' | 'signal'>YesNone
getVoiceRegions(options?):Promise<RESTGetAPIVoiceRegionsResult>
NameTypeOptionalDescription
optionsPick<RequestData, 'auth' | 'signal'>Yes
The options for fetching the voice regions
getVoiceState(options, { auth, signal }?):Promise<APIVoiceState>
NameTypeOptionalDescription
optionsSnowflakeNo
The options for fetching user voice state
{ auth, signal }Pick<RequestData, 'auth' | 'signal'>YesNone