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
guildIdSnowflakeNoThe id of the guild to edit the current user's voice state in
userIdSnowflakeNoThe id of the user to edit the voice state for
bodyRESTPatchAPIGuildVoiceStateUserJSONBodyNoThe data for editing the voice state
optionsPick<RequestData, 'reason' | 'signal'>YesThe options for editing the voice state
editVoiceState(guildId, body?, options?):Promise<never>
NameTypeOptionalDescription
guildIdSnowflakeNoThe id of the guild
bodyRESTPatchAPIGuildVoiceStateCurrentMemberJSONBodyYesThe data for editing the voice state
optionsPick<RequestData, 'signal'>YesThe options for editing the voice state
getUserVoiceState(options, userId, { signal }?):Promise<APIVoiceState>
Fetches voice state of a user by their id
NameTypeOptionalDescription
optionsSnowflakeNoThe options for fetching user voice state
userIdSnowflakeNoNone
{ signal }Pick<RequestData, 'signal'>YesNone
getVoiceRegions(options?):Promise<RESTGetAPIVoiceRegionsResult>
NameTypeOptionalDescription
optionsPick<RequestData, 'signal'>YesThe options for fetching the voice regions
getVoiceState(options, { signal }?):Promise<APIVoiceState>
NameTypeOptionalDescription
optionsSnowflakeNoThe options for fetching user voice state
{ signal }Pick<RequestData, 'signal'>YesNone