Struct EditWebhookMessage

pub struct EditWebhookMessage { /* private fields */ }

A builder to specify the fields to edit in an existing Webhook’s message.

Discord docs

Implementations

impl EditWebhookMessage

pub fn new() -> Self

Equivalent to Self::default.

pub fn content(self, content: impl Into<String>) -> Self

Set the content of the message.

Note: Message contents must be under 2000 unicode code points.

pub fn in_thread(self, thread_id: impl Into<ChannelId>) -> Self

Edits a message within a given thread. If the provided thread Id doesn’t belong to the current webhook, the API will return an error.

pub fn add_embed(self, embed: CreateEmbed) -> Self

Adds an embed for the message.

Embeds from the original message are reset when adding new embeds and must be re-added.

pub fn add_embeds(self, embeds: Vec<CreateEmbed>) -> Self

Adds multiple embeds to the message.

Embeds from the original message are reset when adding new embeds and must be re-added.

pub fn embed(self, embed: CreateEmbed) -> Self

Sets a single embed to include in the message

Calling this will overwrite the embed list. To append embeds, call Self::add_embed instead.

pub fn embeds(self, embeds: Vec<CreateEmbed>) -> Self

Sets the embeds for the message.

Note: You can only have up to 10 embeds per message.

Calling this will overwrite the embed list. To append embeds, call Self::add_embeds instead.

pub fn allowed_mentions(self, allowed_mentions: CreateAllowedMentions) -> Self

Set the allowed mentions for the message.

pub fn components(self, components: Vec<CreateActionRow>) -> Self

Sets the components for this message. Requires an application-owned webhook, meaning either the webhook’s kind field is set to WebhookType::Application, or it was created by an application (and has kind WebhookType::Incoming).

pub fn button(self, button: CreateButton) -> Self

Adds a clickable button to this message.

Convenience method that wraps Self::components. Arranges buttons in action rows automatically.

pub fn select_menu(self, select_menu: CreateSelectMenu) -> Self

Adds an interactive select menu to this message.

Convenience method that wraps Self::components.

pub fn attachments(self, attachments: EditAttachments) -> Self

Sets attachments, see EditAttachments for more details.

pub fn new_attachment(self, attachment: CreateAttachment) -> Self

Adds a new attachment to the message.

Resets existing attachments. See the documentation for EditAttachments for details.

pub fn keep_existing_attachment(self, id: AttachmentId) -> Self

Shorthand for EditAttachments::keep.

pub fn clear_attachments(self) -> Self

Shorthand for calling Self::attachments with EditAttachments::new.

Trait Implementations

impl Builder for EditWebhookMessage

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Edits the webhook’s message.

Note: Message contents must be under 2000 unicode code points, and embeds must be under 6000 code points.

Errors

Returns an Error::Model if the message content is too long.

May also return an Error::Http if the content is malformed, the webhook’s token is invalid, or the given message Id does not belong to the webhook.

Or may return an Error::Json if there is an error deserialising Discord’s response.

type Context<'ctx> = (WebhookId, &'ctx str, MessageId)

Additional data that’s only required when sending a request off to the API.

type Built = Message

impl Clone for EditWebhookMessage

fn clone(&self) -> EditWebhookMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EditWebhookMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EditWebhookMessage

fn default() -> EditWebhookMessage

Returns the “default value” for a type.

impl Serialize for EditWebhookMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.