Struct twilight_http::request::channel::webhook::update_webhook_message::UpdateWebhookMessage [−][src]
pub struct UpdateWebhookMessage<'a> { /* fields omitted */ }
Expand description
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_model::{ channel::message::AllowedMentions, 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
Maximum number of embeds that a webhook’s message may have.
Set the allowed mentions in the message.
Specify an attachment already present in the target message to keep.
If called, all unspecified attachments will be removed from the message. If not called, all attachments will be kept.
Specify multiple attachments already present in the target message to keep.
If called, all unspecified attachments will be removed from the message. If not called, all attachments will be kept.
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 an UpdateWebhookMessageErrorType::ContentInvalid
error type if
the content length is too long.
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 an UpdateWebhookMessageErrorType::EmbedTooLarge
error type
if one of the embeds are too large.
Returns an UpdateWebhookMessageErrorType::TooManyEmbeds
error type
if more than 10 embeds are provided.
Attach a file to the webhook.
This method is repeatable.
Attach multiple files to the webhook.
JSON encoded body of any additional request fields.
If this method is called, all other fields are ignored, except for
file
. See Discord Docs/Create Message and
ExecuteWebhook::payload_json
.
Trait Implementations
Auto Trait Implementations
impl<'a> !RefUnwindSafe for UpdateWebhookMessage<'a>
impl<'a> Send for UpdateWebhookMessage<'a>
impl<'a> !Sync for UpdateWebhookMessage<'a>
impl<'a> Unpin for UpdateWebhookMessage<'a>
impl<'a> !UnwindSafe for UpdateWebhookMessage<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Chain on a computation for when a future finished, passing the result of
the future to the provided closure f
. Read more
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the left-hand variant
of that Either
. Read more
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the right-hand variant
of that Either
. Read more
fn into_stream(self) -> IntoStream<Self>
fn into_stream(self) -> IntoStream<Self>
Convert this future into a single element stream. Read more
Flatten the execution of this future when the output of this future is itself another future. Read more
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self>
fn fuse(self) -> Fuse<Self>
Fuse a future such that poll
will never again be called once it has
completed. This method can be used to turn any Future
into a
FusedFuture
. Read more
Do something with the output of a future before passing it on. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
Wrap the future in a Box, pinning it. Read more
Wrap the future in a Box, pinning it. Read more
fn unit_error(self) -> UnitError<Self>
fn unit_error(self) -> UnitError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
fn never_error(self) -> NeverError<Self>
fn never_error(self) -> NeverError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>. Read more
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
A convenience for calling Future::poll
on Unpin
future types.
fn now_or_never(self) -> Option<Self::Output>
fn now_or_never(self) -> Option<Self::Output>
Evaluates and consumes the future, returning the resulting output if
the future is ready after the first call to Future::poll
. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
into_future
)Creates a future from a value.
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
Maps this future’s success value to a different value. Read more
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more
Maps this future’s error value to a different value. Read more
Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more
Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
Do something with the success value of a future before passing it on. Read more
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
Do something with the error value of a future before passing it on. Read more
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
Flatten the execution of this future when the successful result of this future is another future. Read more
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
fn into_future(self) -> IntoFuture<Self>
fn into_future(self) -> IntoFuture<Self>
pub fn vzip(self) -> V