Struct twilight_http::request::channel::webhook::update_webhook_message::UpdateWebhookMessage

pub struct UpdateWebhookMessage<'a> { /* fields omitted */ }

Update a message created by a webhook.

A webhook’s message must always have at least one embed or some amount of content. If you wish to delete a webhook’s message refer to DeleteWebhookMessage.

Examples

Update a webhook’s message by setting the content to test <@3> - attempting to mention user ID 3 - and specifying that only that the user may not be mentioned.

use twilight_http::request::channel::allowed_mentions::AllowedMentions;
use twilight_model::id::{MessageId, WebhookId};

client.update_webhook_message(WebhookId(1), "token here", MessageId(2))
    // By creating a default set of allowed mentions, no entity can be
    // mentioned.
    .allowed_mentions(AllowedMentions::default())
    .content(Some("test <@3>".to_owned()))?
    .await?;

Implementations

impl<'a> UpdateWebhookMessage<'a>

pub const EMBED_COUNT_LIMIT: usize

Maximum number of embeds that a webhook’s message may have.

pub fn allowed_mentions(self, allowed: AllowedMentions) -> Self

Set the allowed mentions in the message.

pub fn content(
    self,
    content: Option<String>
) -> Result<Self, UpdateWebhookMessageError>

Set the content of the message.

Pass None if you want to remove the message content.

Note that if there is are no embeds then you will not be able to remove the content of the message.

The maximum length is 2000 UTF-16 characters.

Errors

Returns UpdateWebhookMessageError::ContentInvalid if the content length is too long.

pub fn embeds(
    self,
    embeds: Option<Vec<Embed>>
) -> Result<Self, UpdateWebhookMessageError>

Set the list of embeds of the webhook’s message.

Pass None to remove all of the embeds.

The maximum number of allowed embeds is defined by EMBED_COUNT_LIMIT.

The total character length of each embed must not exceed 6000 characters. Additionally, the internal fields also have character limits. Refer to the discord docs for more information.

Examples

Create an embed and update the message with the new embed. The content of the original message is unaffected and only the embed(s) are modified.

use twilight_embed_builder::EmbedBuilder;
use twilight_model::id::{MessageId, WebhookId};

let embed = EmbedBuilder::new()
    .description("Powerful, flexible, and scalable ecosystem of Rust libraries for the Discord API.")?
    .title("Twilight")?
    .url("https://twilight.rs")
    .build()?;

client.update_webhook_message(WebhookId(1), "token", MessageId(2))
    .embeds(Some(vec![embed]))?
    .await?;

Errors

Returns UpdateWebhookMessageError::EmbedTooLarge if one of the embeds are too large.

Returns UpdateWebhookMessageError::TooManyEmbeds if more than 10 embeds are provided.

Trait Implementations

impl<'a> AuditLogReason for UpdateWebhookMessage<'a>

fn reason(self, reason: impl Into<String>) -> Result<Self, AuditLogReasonError>

impl Future for UpdateWebhookMessage<'_>

type Output = Result<()>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.