class UsersAPI

declare class UsersAPI

Constructors

constructor(
rest: REST
)

Constructs a new instance of the UsersAPI class

createDM(
userId: Snowflake
) : 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

edit(
user: RESTPatchAPICurrentUserJSONBody
) : Promise<discord_api_types_v10.APIUser>

Edits the current user

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

editGuildMember(
guildId: Snowflake
member?: RESTPatchAPIGuildMemberJSONBody
reason?: string
) : 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

get(
userId: Snowflake
) : Promise<discord_api_types_v10.APIUser>

Fetches a user by their id

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

getApplicationRoleConnection(
applicationId: Snowflake
) : 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

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: Snowflake
) : 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

getGuilds(
options?: RESTGetAPICurrentUserGuildsQuery
) : 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

leaveGuild(
guildId: Snowflake
) : Promise<void>

Leaves the guild with the given id

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

setVoiceState(
guildId: Snowflake
options?: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody
) : Promise<never>

Sets the voice state for the current user

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

updateApplicationRoleConnection(
applicationId: Snowflake
options: RESTPutAPICurrentUserApplicationRoleConnectionJSONBody
) : 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