Struct Interaction

pub struct Interaction {

    pub app_permissions: Option<Permissions>,
    pub application_id: Id<ApplicationMarker>,
    pub authorizing_integration_owners: ApplicationIntegrationMap<AnonymizableId<GuildMarker>, Id<UserMarker>>,
    pub channel: Option<Channel>,
    pub channel_id: Option<Id<ChannelMarker>>,
    pub context: Option<InteractionContextType>,
    pub data: Option<InteractionData>,
    pub entitlements: Vec<Entitlement>,
    pub guild_id: Option<Id<GuildMarker>>,
    pub guild_locale: Option<String>,
    pub id: Id<InteractionMarker>,
    pub kind: InteractionType,
    pub locale: Option<String>,
    pub member: Option<PartialMember>,
    pub message: Option<Message>,
    pub token: String,
    pub user: Option<User>,
}

Payload received when a user executes an interaction.

See Discord Docs/Interaction Object.

Fields

app_permissions: Option<Permissions>

App’s permissions in the channel the interaction was sent from.

application_id: Id<ApplicationMarker>

ID of the associated application.

authorizing_integration_owners: ApplicationIntegrationMap<AnonymizableId<GuildMarker>, Id<UserMarker>>

Mapping of installation contexts that the interaction was authorized for to related user or guild IDs.

channel: Option<Channel>

The channel the interaction was invoked in.

Present on all interactions types, except Ping.

channel_id: Option<Id<ChannelMarker>>

👎Deprecated: channel_id is deprecated in the discord API and will no be sent in the future, users should use the channel field instead.

ID of the channel the interaction was invoked in.

Present on all interactions types, except Ping.

context: Option<InteractionContextType>

Context where the interaction was triggered from.

data: Option<InteractionData>

Data from the interaction.

This field present on ApplicationCommand, MessageComponent, ApplicationCommandAutocomplete and ModalSubmit interactions. The inner enum variant matches the interaction type.

entitlements: Vec<Entitlement>

For monetized apps, any entitlements for the invoking user, representing access to premium SKUs

guild_id: Option<Id<GuildMarker>>

ID of the guild the interaction was invoked in.

guild_locale: Option<String>

Guild’s preferred locale.

Present when the interaction is invoked in a guild.

id: Id<InteractionMarker>

ID of the interaction.

kind: InteractionType

Type of interaction.

locale: Option<String>

Selected language of the user who invoked the interaction.

Present on all interactions types, except Ping.

member: Option<PartialMember>

Member that invoked the interaction.

Present when the interaction is invoked in a guild.

message: Option<Message>

Message attached to the interaction.

Present on MessageComponent interactions.

token: String

Token for responding to the interaction.

user: Option<User>

User that invoked the interaction.

Present when the interaction is invoked in a direct message.

Implementations

impl Interaction

pub const fn author_id(&self) -> Option<Id<UserMarker>>

ID of the user that invoked the interaction.

This will first check for the member’s user’s ID and then, if not present, check the user’s ID.

pub const fn author(&self) -> Option<&User>

The user that invoked the interaction.

This will first check for the member’s user and then, if not present, check the user.

pub const fn is_dm(&self) -> bool

Whether the interaction was invoked in a DM.

pub const fn is_guild(&self) -> bool

Whether the interaction was invoked in a guild.

Trait Implementations

impl Clone for Interaction

fn clone(&self) -> Interaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Interaction

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Interaction

fn eq(&self, other: &Interaction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Interaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Interaction