moxxy/moxxmpp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(xep): Add docstings for the XEP-0045 routines

Browse Source 
Signed-off-by: Ikjot Singh Dhody <ikjotsd@gmail.com>
This commit is contained in:
Ikjot Singh Dhody 2023-06-20 17:44:24 +05:30
parent 217c3ac236
commit b7d53b8f47
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
packages/moxxmpp/lib/src/xeps/xep_0045/xep_0045.dart
View File

@ -25,6 +25,11 @@ class MUCManager extends XmppManagerBase {
/// Cache lock /// Cache lock
final Lock _cacheLock = Lock(); final Lock _cacheLock = Lock();
/// Queries the information of a Multi-User Chat room.
///
/// Retrieves the information about the specified MUC room by performing a
/// disco info query. Returns a [Result] with the [RoomInformation] on success
/// or an appropriate [MUCError] on failure.
Future<Result<RoomInformation, MUCError>> queryRoomInformation( Future<Result<RoomInformation, MUCError>> queryRoomInformation(
JID roomJID, JID roomJID,
) async { ) async {
@ -44,6 +49,12 @@ class MUCManager extends XmppManagerBase {
} }
} }
/// Joins a Multi-User Chat room.
///
/// Joins the specified MUC room using the provided nickname. Sends a presence
/// stanza with the appropriate attributes to join the room. Returns a [Result]
/// with a boolean value indicating success or failure, or an [MUCError]
/// if applicable.
Future<Result<bool, MUCError>> joinRoom( Future<Result<bool, MUCError>> joinRoom(
JID roomJid, JID roomJid,
String nick, String nick,
@ -72,6 +83,12 @@ class MUCManager extends XmppManagerBase {
return const Result(true); return const Result(true);
} }
/// Leaves a Multi-User Chat room.
///
/// Leaves the specified MUC room by sending an 'unavailable' presence stanza.
/// Removes the corresponding room entry from the cache. Returns a [Result]
/// with a boolean value indicating success or failure, or an [MUCError]
/// if applicable.
Future<Result<bool, MUCError>> leaveRoom( Future<Result<bool, MUCError>> leaveRoom(
JID roomJid, JID roomJid,
) async { ) async {