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

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

Edits the current user

editGuildMember(
guildId: Snowflake
member?: RESTPatchAPIGuildMemberJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuildMember>

Edits the guild member for the current user

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

Fetches a user by their id

getCurrent() : Promise<discord_api_types_v10.APIUser>

Returns the user object of the requester's account

getGuildMember(
guildId: Snowflake
) : Promise<discord_api_types_v10.APIGuildMember>

Fetches the guild member for the current user

getGuilds(
options?: RESTGetAPICurrentUserGuildsQuery
) : Promise<RESTGetAPICurrentUserGuildsResult>

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

leaveGuild(
guildId: Snowflake
) : Promise<void>

Leaves the guild with the given id

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

Sets the voice state for the current user