1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
use crate::model::prelude::*; use serde_json::Value; use std::collections::HashMap; use super::context::Context; use crate::client::bridge::gateway::event::*; use async_trait::async_trait; /// The core trait for handling events by serenity. #[async_trait] pub trait EventHandler: Send + Sync { /// Dispatched when the cache has received and inserted all data from /// guilds. /// /// This process happens upon starting your bot and should be fairly quick. /// However, cache actions performed prior this event may fail as the data /// could be not inserted yet. /// /// Provides the cached guilds' ids. #[cfg(feature = "cache")] async fn cache_ready(&self, _ctx: Context, _guilds: Vec<GuildId>) {} /// Dispatched when a channel is created. /// /// Provides said channel's data. async fn channel_create(&self, _ctx: Context, _channel: &GuildChannel) {} /// Dispatched when a category is created. /// /// Provides said category's data. async fn category_create(&self, _ctx: Context, _category: &ChannelCategory) {} /// Dispatched when a category is deleted. /// /// Provides said category's data. async fn category_delete(&self, _ctx: Context, _category: &ChannelCategory) {} /// Dispatched when a private channel is created. /// /// Provides said channel's data. async fn private_channel_create(&self, _ctx: Context, _channel: &PrivateChannel) {} /// Dispatched when a channel is deleted. /// /// Provides said channel's data. async fn channel_delete(&self, _ctx: Context, _channel: &GuildChannel) {} /// Dispatched when a pin is added, deleted. /// /// Provides said pin's data. async fn channel_pins_update(&self, _ctx: Context, _pin: ChannelPinsUpdateEvent) {} /// Dispatched when a user is added to a `Group`. /// /// Provides the group's id and the user's data. async fn channel_recipient_addition(&self, _ctx: Context, _group_id: ChannelId, _user: User) {} /// Dispatched when a user is removed to a `Group`. /// /// Provides the group's id and the user's data. async fn channel_recipient_removal(&self, _ctx: Context, _group_id: ChannelId, _user: User) {} /// Dispatched when a channel is updated. /// /// Provides the old channel data, and the new data. #[cfg(feature = "cache")] async fn channel_update(&self, _ctx: Context, _old: Option<Channel>, _new: Channel) {} /// Dispatched when a channel is updated. /// /// Provides the new data. #[cfg(not(feature = "cache"))] async fn channel_update(&self, _ctx: Context, _new_data: Channel) {} /// Dispatched when a user is banned from a guild. /// /// Provides the guild's id and the banned user's data. async fn guild_ban_addition(&self, _ctx: Context, _guild_id: GuildId, _banned_user: User) {} /// Dispatched when a user's ban is lifted from a guild. /// /// Provides the guild's id and the lifted user's data. async fn guild_ban_removal(&self, _ctx: Context, _guild_id: GuildId, _unbanned_user: User) {} /// Dispatched when a guild is created; /// or an existing guild's data is sent to us. /// /// Provides the guild's data and whether the guild is new. #[cfg(feature = "cache")] async fn guild_create(&self, _ctx: Context, _guild: Guild, _is_new: bool) {} /// Dispatched when a guild is created; /// or an existing guild's data is sent to us. /// /// Provides the guild's data. #[cfg(not(feature = "cache"))] async fn guild_create(&self, _ctx: Context, _guild: Guild) {} /// Dispatched when a guild is deleted. /// /// Provides the partial data of the guild sent by discord, /// and the full data from the cache, if available. /// /// The `unavailable` flag in the partial data determines the status of the guild. /// If the flag is false, the bot was removed from the guild, either by being /// kicked or banned. If the flag is true, the guild went offline. #[cfg(feature = "cache")] async fn guild_delete(&self, _ctx: Context, _incomplete: GuildUnavailable, _full: Option<Guild>) {} /// Dispatched when a guild is deleted. /// /// Provides the partial data of the guild sent by discord. /// /// The `unavailable` flag in the partial data determines the status of the guild. /// If the flag is false, the bot was removed from the guild, either by being /// kicked or banned. If the flag is true, the guild went offline. #[cfg(not(feature = "cache"))] async fn guild_delete(&self, _ctx: Context, _incomplete: GuildUnavailable) {} /* the emojis were updated. */ /// Dispatched when the emojis are updated. /// /// Provides the guild's id and the new state of the emojis in the guild. async fn guild_emojis_update(&self, _ctx: Context, _guild_id: GuildId, _current_state: HashMap<EmojiId, Emoji>) {} /// Dispatched when a guild's integration is added, updated or removed. /// /// Provides the guild's id. async fn guild_integrations_update(&self, _ctx: Context, _guild_id: GuildId) {} /// Dispatched when a user joins a guild. /// /// Provides the guild's id and the user's member data. /// /// Note: This event will not trigger unless the "guild members" privileged intent /// is enabled on the bot application page. async fn guild_member_addition(&self, _ctx: Context, _guild_id: GuildId, _new_member: Member) {} /// Dispatched when a user's membership ends by leaving, getting kicked, or being banned. /// /// Provides the guild's id, the user's data, and the user's member data if available. /// /// Note: This event will not trigger unless the "guild members" privileged intent /// is enabled on the bot application page. #[cfg(feature = "cache")] async fn guild_member_removal(&self, _ctx: Context, _guild_id: GuildId, _user: User, _member_data_if_available: Option<Member>) {} /// Dispatched when a user's membership ends by leaving, getting kicked, or being banned. /// /// Provides the guild's id, the user's data. /// /// Note: This event will not trigger unless the "guild members" privileged intent /// is enabled on the bot application page. #[cfg(not(feature = "cache"))] async fn guild_member_removal(&self, _ctx: Context, _guild_id: GuildId, _kicked: User) {} /// Dispatched when a member is updated (e.g their nickname is updated). /// /// Provides the member's old data (if available) and the new data. /// /// Note: This event will not trigger unless the "guild members" privileged intent /// is enabled on the bot application page. #[cfg(feature = "cache")] async fn guild_member_update(&self, _ctx: Context, _old_if_available: Option<Member>, _new: Member) {} /// Dispatched when a member is updated (e.g their nickname is updated). /// /// Provides the new data. /// /// Note: This event will not trigger unless the "guild members" privileged intent /// is enabled on the bot application page. #[cfg(not(feature = "cache"))] async fn guild_member_update(&self, _ctx: Context, _new: GuildMemberUpdateEvent) {} /// Dispatched when the data for offline members was requested. /// /// Provides the guild's id and the data. async fn guild_members_chunk(&self, _ctx: Context, _chunk: GuildMembersChunkEvent) {} /// Dispatched when a role is created. /// /// Provides the guild's id and the new role's data. async fn guild_role_create(&self, _ctx: Context, _guild_id: GuildId, _new: Role) {} /// Dispatched when a role is deleted. /// /// Provides the guild's id, the role's id and its data if available. #[cfg(feature = "cache")] async fn guild_role_delete(&self, _ctx: Context, _guild_id: GuildId, _removed_role_id: RoleId, _removed_role_data_if_available: Option<Role>) {} /// Dispatched when a role is deleted. /// /// Provides the guild's id, the role's id. #[cfg(not(feature = "cache"))] async fn guild_role_delete(&self, _ctx: Context, _guild_id: GuildId, _removed_role_id: RoleId) {} /// Dispatched when a role is updated. /// /// Provides the guild's id, the role's old (if available) and new data. #[cfg(feature = "cache")] async fn guild_role_update(&self, _ctx: Context, _guild_id: GuildId, _old_data_if_available: Option<Role>, _new: Role) {} /// Dispatched when a role is updated. /// /// Provides the guild's id and the role's new data. #[cfg(not(feature = "cache"))] async fn guild_role_update(&self, _ctx: Context, _guild_id: GuildId, _new_data: Role) {} /// Dispatched when a guild became unavailable. /// /// Provides the guild's id. async fn guild_unavailable(&self, _ctx: Context, _guild_id: GuildId) {} /// Dispatched when the guild is updated. /// /// Provides the guild's old full data (if available) and the new, albeit partial data. #[cfg(feature = "cache")] async fn guild_update(&self, _ctx: Context, _old_data_if_available: Option<Guild>, _new_but_incomplete: PartialGuild) {} /// Dispatched when the guild is updated. /// /// Provides the guild's new, albeit partial data. #[cfg(not(feature = "cache"))] async fn guild_update(&self, _ctx: Context, _new_but_incomplete_data: PartialGuild) {} /// Dispatched when a invite is created. /// /// Provides data about the invite. async fn invite_create(&self, _ctx: Context, _data: InviteCreateEvent) {} /// Dispatched when a invite is deleted. /// /// Provides data about the invite. async fn invite_delete(&self, _ctx: Context, _data: InviteDeleteEvent) {} /// Dispatched when a message is created. /// /// Provides the message's data. async fn message(&self, _ctx: Context, _new_message: Message) {} /// Dispatched when a message is deleted. /// /// Provides the channel's id and the message's id. async fn message_delete(&self, _ctx: Context, _channel_id: ChannelId, _deleted_message_id: MessageId) {} /// Dispatched when multiple messages were deleted at once. /// /// Provides the channel's id and the deleted messages' ids. async fn message_delete_bulk(&self, _ctx: Context, _channel_id: ChannelId, _multiple_deleted_messages_ids: Vec<MessageId>) {} /// Dispatched when a message is updated. /// /// Provides the old message if available, /// the new message as an option in case of cache inconsistencies, /// and the raw [`MessageUpdateEvent`] as a fallback. /// /// [`MessageUpdateEvent`]: ../model/event/struct.MessageUpdateEvent.html #[cfg(feature = "cache")] async fn message_update(&self, _ctx: Context, _old_if_available: Option<Message>, _new: Option<Message>, _event: MessageUpdateEvent) {} /// Dispatched when a message is updated. /// /// Provides the new data of the message. #[cfg(not(feature = "cache"))] async fn message_update(&self, _ctx: Context, _new_data: MessageUpdateEvent) {} /// Dispatched when a new reaction is attached to a message. /// /// Provides the reaction's data. async fn reaction_add(&self, _ctx: Context, _add_reaction: Reaction) {} /// Dispatched when a reaction is detached from a message. /// /// Provides the reaction's data. async fn reaction_remove(&self, _ctx: Context, _removed_reaction: Reaction) {} /// Dispatched when all reactions of a message are detached from a message. /// /// Provides the channel's id and the message's id. async fn reaction_remove_all(&self, _ctx: Context, _channel_id: ChannelId, _removed_from_message_id: MessageId) {} /// This event is legacy, and likely no longer sent by discord. async fn presence_replace(&self, _ctx: Context, _: Vec<Presence>) {} /// Dispatched when a user's presence is updated (e.g off -> on). /// /// Provides the presence's new data. /// /// Note: This event will not trigger unless the "guild presences" privileged intent /// is enabled on the bot application page. async fn presence_update(&self, _ctx: Context, _new_data: PresenceUpdateEvent) {} /// Dispatched upon startup. /// /// Provides data about the bot and the guilds it's in. async fn ready(&self, _ctx: Context, _data_about_bot: Ready) {} /// Dispatched upon reconnection. async fn resume(&self, _ctx: Context, _: ResumedEvent) {} /// Dispatched when a shard's connection stage is updated /// /// Provides the context of the shard and the event information about the update. async fn shard_stage_update(&self, _ctx: Context, _: ShardStageUpdateEvent) {} /// Dispatched when a user starts typing. async fn typing_start(&self, _ctx: Context, _: TypingStartEvent) {} /// Dispatched when an unknown event was sent from discord. /// /// Provides the event's name and its unparsed data. async fn unknown(&self, _ctx: Context, _name: String, _raw: Value) {} /// Dispatched when the bot's data is updated. /// /// Provides the old and new data. #[cfg(feature = "cache")] async fn user_update(&self, _ctx: Context, _old_data: CurrentUser, _new: CurrentUser) {} /// Dispatched when the bot's data is updated. /// /// Provides the new data. #[cfg(not(feature = "cache"))] async fn user_update(&self, _ctx: Context, _new_data: CurrentUser) {} /// Dispatched when a guild's voice server was updated (or changed to another one). /// /// Provides the voice server's data. async fn voice_server_update(&self, _ctx: Context, _: VoiceServerUpdateEvent) {} /// Dispatched when a user joins, leaves or moves to a voice channel. /// /// Provides the guild's id (if available) and /// the old and the new state of the guild's voice channels. #[cfg(feature = "cache")] async fn voice_state_update(&self, _ctx: Context, _: Option<GuildId>, _old: Option<VoiceState>, _new: VoiceState) {} /// Dispatched when a user joins, leaves or moves to a voice channel. /// /// Provides the guild's id (if available) and /// the new state of the guild's voice channels. #[cfg(not(feature = "cache"))] async fn voice_state_update(&self, _ctx: Context, _: Option<GuildId>, _: VoiceState) {} /// Dispatched when a guild's webhook is updated. /// /// Provides the guild's id and the channel's id the webhook belongs in. async fn webhook_update(&self, _ctx: Context, _guild_id: GuildId, _belongs_to_channel_id: ChannelId) {} } /// This core trait for handling raw events #[async_trait] pub trait RawEventHandler: Send + Sync { /// Dispatched when any event occurs async fn raw_event(&self, _ctx: Context, _ev: Event) {} }