xmpp/
event.rs

1// Copyright (c) 2023 xmpp-rs contributors.
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7use tokio_xmpp::jid::BareJid;
8#[cfg(feature = "avatars")]
9use tokio_xmpp::jid::Jid;
10use tokio_xmpp::parsers::{message::Body, roster::Item as RosterItem};
11
12use crate::{delay::StanzaTimeInfo, Error, MessageId, RoomNick};
13
14#[derive(Debug)]
15pub enum Event {
16    Online,
17    Disconnected(Error),
18    ContactAdded(RosterItem),
19    ContactRemoved(RosterItem),
20    ContactChanged(RosterItem),
21    #[cfg(feature = "avatars")]
22    AvatarRetrieved(Jid, String),
23    /// A chat message was received. It may have been delayed on the network.
24    /// - The [`MessageId`] is a unique identifier for this message.
25    /// - The [`BareJid`] is the sender's JID.
26    /// - The [`Body`] is the message body.
27    /// - The [`StanzaTimeInfo`] about when message was received, and when the message was claimed sent.
28    ChatMessage(Option<MessageId>, BareJid, Body, StanzaTimeInfo),
29    /// A message in a one-to-one chat was corrected/edited.
30    /// - The [`MessageId`] is the ID of the message that was corrected.
31    /// - The [`BareJid`] is the JID of the other participant in the chat.
32    /// - The [`Body`] is the new body of the message, to replace the old one.
33    /// - The [`StanzaTimeInfo`] is the time the message correction was sent/received
34    ChatMessageCorrection(MessageId, BareJid, Body, StanzaTimeInfo),
35    RoomJoined(BareJid),
36    RoomLeft(BareJid),
37    RoomMessage(Option<MessageId>, BareJid, RoomNick, Body, StanzaTimeInfo),
38    /// A message in a MUC was corrected/edited.
39    /// - The [`MessageId`] is the ID of the message that was corrected.
40    /// - The [`BareJid`] is the JID of the room where the message was sent.
41    /// - The [`RoomNick`] is the nickname of the sender of the message.
42    /// - The [`Body`] is the new body of the message, to replace the old one.
43    /// - The [`StanzaTimeInfo`] is the time the message correction was sent/received
44    RoomMessageCorrection(MessageId, BareJid, RoomNick, Body, StanzaTimeInfo),
45    /// The subject of a room was received.
46    /// - The BareJid is the room's address.
47    /// - The RoomNick is the nickname of the room member who set the subject.
48    /// - The String is the new subject.
49    RoomSubject(BareJid, Option<RoomNick>, String, StanzaTimeInfo),
50    /// A private message received from a room, containing the message ID, the room's BareJid,
51    /// the sender's nickname, and the message body.
52    RoomPrivateMessage(Option<MessageId>, BareJid, RoomNick, Body, StanzaTimeInfo),
53    /// A private message in a MUC was corrected/edited.
54    /// - The [`MessageId`] is the ID of the message that was corrected.
55    /// - The [`BareJid`] is the JID of the room where the message was sent.
56    /// - The [`RoomNick`] is the nickname of the sender of the message.
57    /// - The [`Body`] is the new body of the message, to replace the old one.
58    /// - The [`StanzaTimeInfo`] is the time the message correction was sent/received
59    RoomPrivateMessageCorrection(MessageId, BareJid, RoomNick, Body, StanzaTimeInfo),
60    ServiceMessage(Option<MessageId>, BareJid, Body, StanzaTimeInfo),
61    HttpUploadedFile(String),
62}
xmpp/event.rs

xmpp/
event.rs
