pep/xmpp-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Clarified the doc comments for leave_room.

Browse source
This commit is contained in:
Werner Kroneman 2023-12-09 13:26:23 +01:00
parent ecd0be4aad
commit a993770206
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
xmpp/src/lib.rs
View file

@ -241,7 +241,7 @@ impl Agent {
let _ = self.client.send_stanza(presence.into()).await;
}
/// Send a "leave room" request to the server.
/// 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.
@ -250,6 +250,10 @@ impl Agent {
///
/// 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).
///
/// # Arguments
///
/// * `room_jid`: The JID of the room to leave.