discord.js | UsersAPI

/

/

/

/

/

UsersAPI%3AClass

Search...

K

UsersAPI

export declare class UsersAPI

export 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, options?):Promise<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
options	Pick<RequestData, 'signal'>	Yes	The options for opening the DM

edit(body, options?):Promise<APIUser>

Edits the current user

See Also

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

Name	Type	Optional	Description
body	RESTPatchAPICurrentUserJSONBody	No	The new data for the current user
options	Pick<RequestData, 'signal'>	Yes	The options for editing the user

editCurrentGuildMember(guildId, body?, options?):Promise<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
body	RESTPatchAPIGuildMemberJSONBody	Yes	The new data for the guild member
options	Pick<RequestData, 'reason' \| 'signal'>	Yes	The options for editing the guild member

get(userId, options?):Promise<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
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the user

getApplicationRoleConnection(applicationId, options?):Promise<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
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the role connections

getConnections(options?):Promise<RESTGetAPICurrentUserConnectionsResult>

Gets the current user's connections

See Also

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

Name	Type	Optional	Description
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the user's connections

getCurrent(options?):Promise<APIUser>

Returns the user object of the requester's account

See Also

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

Name	Type	Optional	Description
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the current user

getGuildMember(guildId, options?):Promise<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
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the guild member

getGuilds(query?, 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
query	RESTGetAPICurrentUserGuildsQuery	Yes	The query options for fetching the current user's guilds
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the guilds

leaveGuild(guildId, options?):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
options	Pick<RequestData, 'signal'>	Yes	The options for leaving the guild

updateApplicationRoleConnection(applicationId, body, options?):Promise<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
body	RESTPutAPICurrentUserApplicationRoleConnectionJSONBody	No	The data for updating the application role connection
options	Pick<RequestData, 'signal'>	Yes	The options for updating the application role connection