Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-11 17:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clean up dd6dd6f

Browse Source
This commit is contained in:
Schuyler Cebulskie
2017-02-21 15:07:45 -05:00
parent db5259cdf1
commit 8d1bc30e40
2 changed files with 11 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/structures/Guild.js
View File

@@ -330,20 +330,15 @@ class Guild {
}
/**
* The data for a role
* @typedef {Object} AddGuildMemberOptions
* @property {string} accessToken An oauth2 access token granted with the guilds.join to the bot's application
* for the user you want to add to the guild
* @property {string} [nick] Value to set users nickname to
* @property {Collection<Snowflake, Role>|Role[]|string[]} [roles] The roles or role IDs to add
* @property {boolean} [mute] If the user is muted
* @property {boolean} [deaf] If the user is deafened
*/
/**
* Add a user to this guild using OAuth2
* @param {UserResolvable|string} user The user or ID of the user to add to guild
* @param {AddGuildMemberOptions} options Options object containing the access_token
* Adds a user to the guild using OAuth2. Requires the `CREATE_INSTANT_INVITE` permission.
* @param {UserResolvable} user User to add to the guild
* @param {Object} options Options for the addition
* @param {string} options.accessToken An OAuth2 access token for the user with the `guilds.join` scope granted to the
* bot's application
* @param {string} [options.nick] Nickname to give the member
* @param {Collection<Snowflake, Role>|Role[]|Snowflake[]} [options.roles] Roles to add to the member
* @param {boolean} [options.mute] Whether the member should be muted
* @param {boolean} [options.deaf] Whether the member should be deafened
* @returns {Promise<GuildMember>}
*/
addMember(user, options) {