discord.js | UsersAPI

/

/

/

/

/

UsersAPI%3AClass

Search...

K

UsersAPI

declare class UsersAPI

declare class UsersAPI

No summary provided.

constructor(rest)

Constructs a new instance of the UsersAPI class

Name	Type	Optional	Description
rest	REST	No	None

createDM(userId):Promise<discord_api_types_v10.APIChannel>

Opens a new DM channel with a user

See Also

https://discord.com/developers/docs/resources/user#create-dm

Name	Type	Optional	Description
userId	Snowflake	No	The id of the user to open a DM channel with

edit(user):Promise<discord_api_types_v10.APIUser>

Edits the current user

See Also

https://discord.com/developers/docs/resources/user#modify-current-user

Name	Type	Optional	Description
user	RESTPatchAPICurrentUserJSONBody	No	The new data for the current user

editGuildMember(guildId, member?, reason?):Promise<discord_api_types_v10.APIGuildMember>

Edits the guild member for the current user

See Also

https://discord.com/developers/docs/resources/guild#modify-current-member

Name	Type	Optional	Description
guildId	Snowflake	No	The id of the guild
member	RESTPatchAPIGuildMemberJSONBody	Yes	The new data for the guild member
reason	string	Yes	The reason for editing this guild member

get(userId):Promise<discord_api_types_v10.APIUser>

Fetches a user by their id

See Also

https://discord.com/developers/docs/resources/user#get-user

Name	Type	Optional	Description
userId	Snowflake	No	The id of the user to fetch

getApplicationRoleConnection(applicationId):Promise<discord_api_types_v10.APIApplicationRoleConnection>

Gets the current user's active application role connection

See Also

https://discord.com/developers/docs/resources/user#get-user-application-role-connection

Name	Type	Optional	Description
applicationId	Snowflake	No	The id of the application

getConnections():Promise<RESTGetAPICurrentUserConnectionsResult>

Gets the current user's connections

See Also

https://discord.com/developers/docs/resources/user#get-user-connections

getCurrent():Promise<discord_api_types_v10.APIUser>

Returns the user object of the requester's account

See Also

https://discord.com/developers/docs/resources/user#get-current-user

getGuildMember(guildId):Promise<discord_api_types_v10.APIGuildMember>

Fetches the guild member for the current user

See Also

https://discord.com/developers/docs/resources/user#get-current-user-guild-member

Name	Type	Optional	Description
guildId	Snowflake	No	The id of the guild

getGuilds(options?):Promise<RESTGetAPICurrentUserGuildsResult>

Returns a list of partial guild objects the current user is a member of

See Also

https://discord.com/developers/docs/resources/user#get-current-user-guilds

Name	Type	Optional	Description
options	RESTGetAPICurrentUserGuildsQuery	Yes	The options to use when fetching the current user's guilds

leaveGuild(guildId):Promise<void>

Leaves the guild with the given id

See Also

https://discord.com/developers/docs/resources/user#leave-guild

Name	Type	Optional	Description
guildId	Snowflake	No	The id of the guild

setVoiceState(guildId, options?):Promise<never>

Sets the voice state for the current user

See Also

https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state

Name	Type	Optional	Description
guildId	Snowflake	No	The id of the guild
options	RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody	Yes	The options to use when setting the voice state

updateApplicationRoleConnection(applicationId, options):Promise<discord_api_types_v10.APIApplicationRoleConnection>

Updates the current user's application role connection

See Also

https://discord.com/developers/docs/resources/user#update-user-application-role-connection

Name	Type	Optional	Description
applicationId	Snowflake	No	The id of the application
options	RESTPutAPICurrentUserApplicationRoleConnectionJSONBody	No	The options to use when updating the application role connection