Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document flags for editMessage #567

Merged
merged 8 commits into from Nov 23, 2019
Merged

Document flags for editMessage #567

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ad5e637
Document flags for editMessage
Khaaz Nov 23, 2019
45f3263
oups, didn't mean to delete that
Khaaz Nov 23, 2019
772fa3b
Actually allow to editMessage with only flags
Khaaz Nov 23, 2019
c67ef7d
Also document flags for Message, PrivateChannel, TextChannel
Khaaz Nov 23, 2019
f923aed
Merge branch 'dev' into dev
abalabahaha Nov 23, 2019
2aed2d8
Adds a link to dapi doc
Khaaz Nov 23, 2019
9d18cf4
Merge branch 'dev' into dev
abalabahaha Nov 23, 2019
fab0f52
Merge branch 'dev' into dev
abalabahaha Nov 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion index.d.ts
View file
Open in desktop
Expand Up @@ -495,7 +495,7 @@ declare namespace Eris {
[key: string]: {};
}

type MessageContent = string | { content?: string; tts?: boolean; disableEveryone?: boolean; embed?: EmbedOptions };
type MessageContent = string | { content?: string; tts?: boolean; disableEveryone?: boolean; embed?: EmbedOptions; flags?: number };
interface MessageFile {
file: Buffer | string;
name: string;
Expand Down
5 changes: 3 additions & 2 deletions lib/Client.js
View file
Open in desktop
Expand Up @@ -1085,6 +1085,7 @@ class Client extends EventEmitter {
* @arg {String} content.content A content string
* @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
* @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
* @arg {Number} [content.flags] A number representing the flags to apply to the message
* @returns {Promise<Message>}
*/
editMessage(channelID, messageID, content) {
Expand All @@ -1095,8 +1096,8 @@ class Client extends EventEmitter {
};
} else if(content.content !== undefined && typeof content.content !== "string") {
content.content = "" + content.content;
} else if(content.content === undefined && !content.embed) {
return Promise.reject(new Error("No content or embed"));
} else if(content.content === undefined && !content.embed && content.flags === undefined) {
return Promise.reject(new Error("No content, embed or flags"));
}
if(content.content && (content.disableEveryone !== undefined ? content.disableEveryone : this.options.disableEveryone)) {
content.content = content.content.replace(/@everyone/g, "@\u200beveryone").replace(/@here/g, "@\u200bhere");
Expand Down
1 change: 1 addition & 0 deletions lib/structures/Message.js
View file
Open in desktop
Expand Up @@ -226,6 +226,7 @@ class Message extends Base {
* @arg {String} content.content A content string
* @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
* @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
* @arg {Number} [content.flags] A number representing the flags to apply to the message
* @returns {Promise<Message>}
*/
edit(content) {
Expand Down
1 change: 1 addition & 0 deletions lib/structures/PrivateChannel.js
View file
Open in desktop
Expand Up @@ -118,6 +118,7 @@ class PrivateChannel extends Channel {
* @arg {String} content.content A content string
* @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
* @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
* @arg {Number} [content.flags] A number representing the flags to apply to the message
* @returns {Promise<Message>}
*/
editMessage(messageID, content) {
Expand Down
1 change: 1 addition & 0 deletions lib/structures/TextChannel.js
View file
Open in desktop
Expand Up @@ -165,6 +165,7 @@ class TextChannel extends GuildChannel {
* @arg {String} content.content A content string
* @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
* @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
* @arg {Number} [content.flags] A number representing the flags to apply to the message
* @returns {Promise<Message>}
*/
editMessage(messageID, content) {
Expand Down