Struct serenity::model::channel::Message

pub struct Message {
    pub id: MessageId,
    pub attachments: Vec<Attachment>,
    pub author: User,
    pub channel_id: ChannelId,
    pub content: String,
    pub edited_timestamp: Option<DateTime<FixedOffset>>,
    pub embeds: Vec<Embed>,
    pub kind: MessageType,
    pub mention_everyone: bool,
    pub mention_roles: Vec<RoleId>,
    pub mentions: Vec<User>,
    pub nonce: Value,
    pub pinned: bool,
    pub reactions: Vec<MessageReaction>,
    pub timestamp: DateTime<FixedOffset>,
    pub tts: bool,
    pub webhook_id: Option<WebhookId>,
}

A representation of a message over a guild's text channel, a group, or a private channel.

Fields

id: MessageId

The unique Id of the message. Can be used to calculate the creation date of the message.

attachments: Vec<Attachment>

An vector of the files attached to a message.

author: User

The user that sent the message.

channel_id: ChannelId

The Id of the Channel that the message was sent to.

content: String

The content of the message.

edited_timestamp: Option<DateTime<FixedOffset>>

The timestamp of the last time the message was updated, if it was.

embeds: Vec<Embed>

Array of embeds sent with the message.

kind: MessageType

Indicator of the type of message this is, i.e. whether it is a regular message or a system message.

mention_everyone: bool

Indicator of whether the message mentions everyone.

mention_roles: Vec<RoleId>

Array of Roles' Ids mentioned in the message.

mentions: Vec<User>

Array of users mentioned in the message.

nonce: Value

Non-repeating number used for ensuring message order.

pinned: bool

Indicator of whether the message is pinned.

reactions: Vec<MessageReaction>

Array of reactions performed on the message.

timestamp: DateTime<FixedOffset>

Initial message creation timestamp, calculated from its Id.

tts: bool

Indicator of whether the command is to be played back via text-to-speech.

In the client, this is done via the /tts slash command.

webhook_id: Option<WebhookId>

The Id of the webhook that sent this message, if one did.

Methods

impl Message

fn channel(&self) -> Option<Channel>

Retrieves the related channel located in the cache.

Returns None if the channel is not in the cache.

Examples

On command, print the name of the channel that a message took place in:

use serenity::model::channel::Channel;
use serenity::framework::StandardFramework;

client.with_framework(StandardFramework::new()
    .configure(|c| c.prefix("~"))
    .cmd("channelname", channel_name));

command!(channel_name(_ctx, msg) {
    let _ = match msg.channel() {
        Some(Channel::Category(c)) => msg.reply(&c.read().name),
        Some(Channel::Group(c)) => msg.reply(&c.read().name()),
        Some(Channel::Guild(c)) => msg.reply(&c.read().name),
        Some(Channel::Private(c)) => {
            let channel = c.read();
            let user = channel.recipient.read();

            msg.reply(&format!("DM with {}", user.name.clone()))
        },
        None => msg.reply("Unknown"),
    };
});

fn is_own(&self) -> bool

A util function for determining whether this message was sent by someone else, or the bot.

fn delete(&self) -> Result<()>

Deletes the message.

Note: The logged in user must either be the author of the message or have the Manage Messages permission.

Errors

If the cache feature is enabled, then returns a ModelError::InvalidPermissions if the current user does not have the required permissions.

fn delete_reactions(&self) -> Result<()>

Deletes all of the Reactions associated with the message.

Note: Requires the Manage Messages permission.

Errors

If the cache feature is enabled, then returns a ModelError::InvalidPermissions if the current user does not have the required permissions.

fn edit<F>(&mut self, f: F) -> Result<()> where
    F: FnOnce(EditMessage) -> EditMessage, 

Edits this message, replacing the original content with new content.

Message editing preserves all unchanged message data.

Refer to the documentation for EditMessage for more information regarding message restrictions and requirements.

Note: Requires that the current user be the author of the message.

Examples

Edit a message with new content:

// assuming a `message` has already been bound

message.edit(|m| m.content("new content"));

Errors

If the cache is enabled, returns a ModelError::InvalidUser if the current user is not the author.

Returns a ModelError::MessageTooLong if the content of the message is over the limit, containing the number of unicode code points over the limit.

fn content_safe(&self) -> String

Returns message content, but with user and role mentions replaced with names and everyone/here mentions cancelled.

fn reaction_users<R, U>(
    &self,
    reaction_type: R,
    limit: Option<u8>,
    after: U
) -> Result<Vec<User>> where
    R: Into<ReactionType>,
    U: Into<Option<UserId>>, 

Gets the list of Users who have reacted to a Message with a certain Emoji.

The default limit is 50 - specify otherwise to receive a different maximum number of users. The maximum that may be retrieve at a time is 100, if a greater number is provided then it is automatically reduced.

The optional after attribute is to retrieve the users after a certain user. This is useful for pagination.

Note: Requires the Read Message History permission.

fn guild(&self) -> Option<Arc<RwLock<Guild>>>

Returns the associated Guild for the message if one is in the cache.

Returns None if the guild's Id could not be found via guild_id or if the Guild itself is not cached.

Requires the cache feature be enabled.

fn guild_id(&self) -> Option<GuildId>

Retrieves the Id of the guild that the message was sent in, if sent in one.

Returns None if the channel data or guild data does not exist in the cache.

fn is_private(&self) -> bool

True if message was sent using direct messages.

fn member(&self) -> Option<Member>

Retrieves a clone of the author's Member instance, if this message was sent in a guild.

Note that since this clones, it is preferable performance-wise to manually retrieve the guild from the cache and access Guild::members.

fn overflow_length(content: &str) -> Option<u64>

Checks the length of a string to ensure that it is within Discord's maximum message length limit.

Returns None if the message is within the limit, otherwise returns Some with an inner value of how many unicode code points the message is over.

fn pin(&self) -> Result<()>

Pins this message to its channel.

Note: Requires the Manage Messages permission.

Errors

If the cache is enabled, returns a ModelError::InvalidPermissions if the current user does not have the required permissions.

fn react<R: Into<ReactionType>>(&self, reaction_type: R) -> Result<()>

React to the message with a custom Emoji or unicode character.

Note: Requires the Add Reactions permission.

Errors

If the cache is enabled, returns a ModelError::InvalidPermissions if the current user does not have the required permissions.

fn reply(&self, content: &str) -> Result<Message>

Replies to the user, mentioning them prior to the content in the form of: @<USER_ID>: YOUR_CONTENT.

User mentions are generally around 20 or 21 characters long.

Note: Requires the Send Messages permission.

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

Errors

If the cache is enabled, returns a ModelError::InvalidPermissions if the current user does not have the required permissions.

Returns a ModelError::MessageTooLong if the content of the message is over the above limit, containing the number of unicode code points over the limit.

fn unpin(&self) -> Result<()>

Unpins the message from its channel.

Note: Requires the Manage Messages permission.

Errors

If the cache is enabled, returns a ModelError::InvalidPermissions if the current user does not have the required permissions.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.