Struct twilight_http::request::channel::message::GetChannelMessages

pub struct GetChannelMessages<'a> { /* private fields */ }

Get channel messages, by Id<ChannelMarker>.

Only one of after, around, and before can be specified at a time. Once these are specified, the type returned is GetChannelMessagesConfigured.

If limit is unspecified, the default set by Discord is 50.

Examples

use twilight_http::Client;
use twilight_model::id::Id;

let client = Client::new("my token".to_owned());
let channel_id = Id::new(123);
let message_id = Id::new(234);

let messages = client
    .channel_messages(channel_id)
    .before(message_id)
    .limit(6u16)?
    .exec()
    .await?;

Implementations

impl<'a> GetChannelMessages<'a>

pub const fn after(
    self,
    message_id: Id<MessageMarker>
) -> GetChannelMessagesConfigured<'a>

pub const fn around(
    self,
    message_id: Id<MessageMarker>
) -> GetChannelMessagesConfigured<'a>

pub const fn before(
    self,
    message_id: Id<MessageMarker>
) -> GetChannelMessagesConfigured<'a>

pub const fn limit(self, limit: u16) -> Result<Self, ValidationError>

Set the maximum number of messages to retrieve.

The minimum is 1 and the maximum is 100.

Errors

Returns an error of type GetChannelMessages error type if the amount is less than 1 or greater than 100.

pub fn exec(self) -> ResponseFuture<ListBody<Message>>

Execute the request, returning a future resolving to a Response.

Trait Implementations

impl TryIntoRequest for GetChannelMessages<'_>

fn try_into_request(self) -> Result<Request, HttpError>

Try to convert a request builder into a raw Request.