Struct serenity::model::Reaction

pub struct Reaction {
    pub channel_id: ChannelId,
    pub emoji: ReactionType,
    pub message_id: MessageId,
    pub user_id: UserId,
}

An Emoji reaction to a Message.

Fields

channel_id: ChannelId

The Channel of the associated Message.

emoji: ReactionType

The reactive emoji used.

message_id: MessageId

The Message that was reacted to.

user_id: UserId

The Id of the User that sent the reaction.

Methods

impl Reaction

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

Deletes the reaction, but only if the current user is the user who made the reaction or has permission to.

Note: Requires the [Manage Messages] permission, if the current user did not perform the reaction.

Errors

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

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

Retrieves 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.

Errors

Returns a ClientError::InvalidPermissions if the current user does not have the required permissions.

Trait Implementations

impl Clone for Reaction

fn clone(&self) -> Reaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reaction

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

Formats the value using the given formatter.