Add permission disclaimer to message flag updates

disgoorg · Aug 29, 2024 · 05823bc · 05823bc
1 parent a9131f0
commit 05823bc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/discord/message_update.go b/discord/message_update.go
@@ -8,7 +8,10 @@ type MessageUpdate struct {
 	Attachments     *[]AttachmentUpdate   `json:"attachments,omitempty"`
 	Files           []*File               `json:"-"`
 	AllowedMentions *AllowedMentions      `json:"allowed_mentions,omitempty"`
-	Flags           *MessageFlags         `json:"flags,omitempty"`
+	// Flags are the MessageFlags of the message.
+	// Be careful not to override the current flags when editing messages from other users - this will result in a permission error.
+	// Use MessageFlags.Add for flags like discord.MessageFlagSuppressEmbeds.
+	Flags *MessageFlags `json:"flags,omitempty"`
 }
 
 func (MessageUpdate) interactionCallbackData() {}

diff --git a/discord/message_update_builder.go b/discord/message_update_builder.go
@@ -207,7 +207,9 @@ func (b *MessageUpdateBuilder) ClearAllowedMentions() *MessageUpdateBuilder {
 	return b.SetAllowedMentions(nil)
 }
 
-// SetFlags sets the message flags of the Message
+// SetFlags sets the MessageFlags of the Message.
+// Be careful not to override the current flags when editing messages from other users - this will result in a permission error.
+// Use SetSuppressEmbeds or AddFlags for flags like discord.MessageFlagSuppressEmbeds.
 func (b *MessageUpdateBuilder) SetFlags(flags MessageFlags) *MessageUpdateBuilder {
 	if b.Flags == nil {
 		b.Flags = new(MessageFlags)