Struct xmpp::agent::Agent

pub struct Agent<C: ServerConnector> { /* private fields */ }

Implementations

impl<C: ServerConnector> Agent<C>

pub async fn disconnect(&mut self) -> Result<(), Error>

pub async fn join_room( &mut self, room: BareJid, nick: Option<String>, password: Option<String>, lang: &str, status: &str, )

pub async fn leave_room( &mut self, room_jid: BareJid, nickname: RoomNick, lang: impl Into<String>, status: impl Into<String>, )

Send a “leave room” request to the server (specifically, an “unavailable” presence stanza).

The returned future will resolve when the request has been sent, not when the room has actually been left.

If successful, a RoomLeft event should be received later as a confirmation.

See: https://xmpp.org/extensions/xep-0045.html#exit

Note that this method does NOT remove the room from the auto-join list; the latter is more a list of bookmarks that the account knows about and that have a flag set to indicate that they should be joined automatically after connecting (see the JoinRoom event).

Regarding the latter, see the these minutes about auto-join behavior: https://docs.modernxmpp.org/meetings/2019-01-brussels/#bookmarks

Arguments

• room_jid: The JID of the room to leave.
• nickname: The nickname to use in the room.
• lang: The language of the status message.
• status: The status message to send.

pub async fn send_message( &mut self, recipient: Jid, type_: MessageType, lang: &str, text: &str, ) -> Result<String, Error>

Send a message to a given recipient.

Returns the generated message ID.

Arguments

• recipient: The JID of the recipient.
• type_: The type of message to send. For a message to a MUC room, this should be MessageType::Groupchat. For a private message to a MUC room member or regular contact, this should be MessageType::Chat.
• lang: The language of the message. (See IETF RFC 5646)
• text: The text of the message.

pub async fn send_room_private_message( &mut self, room: BareJid, recipient: RoomNick, lang: &str, text: &str, ) -> Result<String, Error>

Send a private message to a given MUC room member.

Returns the generated message ID.

Arguments

• room: The JID of the room.
• recipient: The nickname of the recipient within the room.
• type_: The type of message to send. For a message to a MUC room, this should be MessageType::Groupchat. For a private message to a MUC room member or regular contact, this should be MessageType::Chat.
• lang: The language of the message. (See IETF RFC 5646)
• text: The text of the message.

Returns the generated message ID, or an error if the message could not be sent.

pub async fn wait_for_events(&mut self) -> Option<Vec<Event>>

Wait for new events.

Returns

• Some(events) if there are new events; multiple may be returned at once.
• None if the underlying stream is closed.

pub async fn upload_file_with(&mut self, service: &str, path: &Path)

pub fn bound_jid(&self) -> Option<&Jid>

Get the bound jid of the client.

If the client is not connected, this will be None.