Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JustCat80 committed May 30, 2021
1 parent 24e9fdb commit 2c175be
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
11 changes: 5 additions & 6 deletions lib/structures/Interaction.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ class Interaction extends Base {
* @arg {Boolean | Array<String>} [content.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
* @arg {String} content.content A content string
* @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#embed-object) for object structure
* @arg {Object | Array<Object>} [options.file] A file object (or an Array of them)
* @arg {Buffer} options.file.file A buffer containing file data
* @arg {String} options.file.name What to name the file
* @arg {Object | Array<Object>} [content.file] A file object (or an Array of them)
* @arg {Buffer} content.file.file A buffer containing file data
* @arg {String} content.file.name What to name the file
* @arg {Boolean} [content.tts] Set the message TTS flag
* @arg {Boolean} [content.flags] 64 for Ephemeral
* @returns {Promise}
Expand Down Expand Up @@ -120,7 +120,7 @@ class Interaction extends Base {
}

/**
* Respond to the interaction
* Respond to the interaction !use createFollowup if you have already responded with a different method
* @arg {String | Object} content A string or object. If an object is passed:
* @arg {Object} [content.allowedMentions] A list of mentions to allow (overrides default)
* @arg {Boolean} [content.allowedMentions.everyone] Whether or not to allow @everyone/@here.
Expand Down Expand Up @@ -188,7 +188,7 @@ class Interaction extends Base {

/**
* Edit a message
* @arg {String} messageId the id of the message to edit, or "@original" for the original response
* @arg {String} messageId the id of the message to edit, or "@original" for the original response, "@original" will will error with ephemeral messages
* @arg {String | Object} content What to edit the message with
* @returns {Promise}
*/
Expand Down Expand Up @@ -249,5 +249,4 @@ class Interaction extends Base {

}


module.exports = Interaction;
1 change: 0 additions & 1 deletion lib/structures/InteractionData.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ const Base = require("./Base");
* Data within an Interaction Object
* @prop {Number?} componentType The type of Message Component (Message Component only)
* @prop {String?} id The ID of the Interaction Data Button id (Message Component), or Command Id (Slash Command)
* @prop {String?} name The command name (Slash Command only)
* @prop {Array<Object>?} options The run Slash Command options (Slash Command only)
* @prop {String?} options.name The name of the Slash Command option (Slash Command only)
Expand Down

0 comments on commit 2c175be

Please sign in to comment.