Enum Event

pub enum Event {
    Online,
    Disconnected(Error),
    ContactAdded(Item),
    ContactRemoved(Item),
    ContactChanged(Item),
    AvatarRetrieved(Jid, String),
    ChatMessage(Id, BareJid, Body, StanzaTimeInfo),
    JoinRoom(BareJid, Conference),
    LeaveRoom(BareJid),
    LeaveAllRooms,
    RoomJoined(BareJid),
    RoomLeft(BareJid),
    RoomMessage(Id, BareJid, RoomNick, Body, StanzaTimeInfo),
    RoomSubject(BareJid, Option<RoomNick>, String, StanzaTimeInfo),
    RoomPrivateMessage(Id, BareJid, RoomNick, Body, StanzaTimeInfo),
    ServiceMessage(Id, BareJid, Body, StanzaTimeInfo),
    HttpUploadedFile(String),
}

An Event the client should react to.

This can be an XMPP event received from the server, or existing state communicated by the server to the client, like when receiving the contact list.

Variants

Online

The client has connected to the server.

Disconnected(Error)

The client has been disconnected from the server. Unless reconnect is enabled, no more event will be received.

ContactAdded(Item)

A contact is received from the server, because it was added recently to the contact list (roster), or because the client went online and is receiving the existing roster.

ContactRemoved(Item)

A contact has been removed from the roster on the server.

ContactChanged(Item)

A contact changed in the roster.

This can happen because (non-exhaustive):

• the contact’s nickname changed
• the contact’s subscription status changed (eg. they accepted a friend request)
• the contact has been added to or removed from a contact group

AvatarRetrieved(Jid, String)

Available on crate feature avatars only.

An avatar for a certain JID was retrieved from the server.

The associated String is a local filesystem path where the crate has saved the avatar data. For now, it’s not possible to configure where the avatars are stored, see issue !112 for more information.

ChatMessage(Id, BareJid, Body, StanzaTimeInfo)

A chat message was received. It may have been delayed on the network.

• The Id is a unique identifier for this message.
• The BareJid is the sender’s JID.
• The Body is the message body.
• The StanzaTimeInfo about when message was received, and when the message was claimed sent.

JoinRoom(BareJid, Conference)

A room with the given Jid was retrieved from the bookmarks, and has been marked for auto-join. The client should join it.

LeaveRoom(BareJid)

TODO

LeaveAllRooms

TODO: WHY?

RoomJoined(BareJid)

An event signaling that a room was joined; after this the client should receive messages from the room and may send messages to it.

RoomLeft(BareJid)

An event signaling that a room was left; after this the client should not receive messages from the room and should not send messages to it.

RoomMessage(Id, BareJid, RoomNick, Body, StanzaTimeInfo)

A message was received from a room, containing the room JID, the sender’s nickname, the message body, and the message timing information.

RoomSubject(BareJid, Option<RoomNick>, String, StanzaTimeInfo)

The subject of a room was received.

• The BareJid is the room’s address.
• The RoomNick is the nickname of the room member who set the subject.
• The String is the new subject.

RoomPrivateMessage(Id, BareJid, RoomNick, Body, StanzaTimeInfo)

A private message received from a room member, containing the message ID, the room’s BareJid, the sender’s nickname in the room, the message body, and the message timing information.

ServiceMessage(Id, BareJid, Body, StanzaTimeInfo)

A service message was received.

HttpUploadedFile(String)

A file has been uploaded over HTTP; contains the URL of the file.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.