From 93adc6aec9ba4671884d9692308b239d3064e553 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Sat, 21 Aug 2010 19:15:30 +0000 Subject: add doc html --- doc/html/classQXmppMucManager.html | 334 +++++++++++++++++++++++++++++++++++++ 1 file changed, 334 insertions(+) create mode 100644 doc/html/classQXmppMucManager.html (limited to 'doc/html/classQXmppMucManager.html') diff --git a/doc/html/classQXmppMucManager.html b/doc/html/classQXmppMucManager.html new file mode 100644 index 00000000..2b8cfdfd --- /dev/null +++ b/doc/html/classQXmppMucManager.html @@ -0,0 +1,334 @@ + + + + + +QXmpp: QXmppMucManager Class Reference + + + + + + + + + +
+

QXmppMucManager Class Reference
+ +[Managers] +

+

The QXmppMucManager class makes it possible to interact with multi-user chat rooms as defined by XEP-0045: Multi-User Chat. +More...

+ +

#include <QXmppMucManager.h>

+ +

List of all members.

+ + + + + + + + + + + + + + + + +

Signals

+void invitationReceived (const QString &roomJid, const QString &inviter, const QString &reason)
 This signal is emitted when an invitation to a chat room is received.
+void roomConfigurationReceived (const QString &roomJid, const QXmppDataForm &configuration)
 This signal is emitted when the configuration form for a chat room is received.
+void roomParticipantChanged (const QString &roomJid, const QString &nickName)

Public Member Functions

+ QXmppMucManager (QXmppStream *stream, QObject *parent=0)
bool joinRoom (const QString &roomJid, const QString &nickName)
bool leaveRoom (const QString &roomJid)
bool requestRoomConfiguration (const QString &roomJid)
bool setRoomConfiguration (const QString &roomJid, const QXmppDataForm &form)
bool sendInvitation (const QString &roomJid, const QString &jid, const QString &reason)
bool sendMessage (const QString &roomJid, const QString &text)
QMap< QString, QXmppPresence > roomParticipants (const QString &bareJid) const
+

Detailed Description

+

The QXmppMucManager class makes it possible to interact with multi-user chat rooms as defined by XEP-0045: Multi-User Chat.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
bool QXmppMucManager::joinRoom (const QString &  roomJid,
const QString &  nickName 
)
+
+
+

Joins the given chat room with the requested nickname.

+
Parameters:
+ + + +
roomJid 
nickName 
+
+
+
Returns:
true if the request was sent, false otherwise
+ +
+
+ +
+
+ + + + + + + + + +
bool QXmppMucManager::leaveRoom (const QString &  roomJid ) 
+
+
+

Leaves the given chat room.

+
Parameters:
+ + +
roomJid 
+
+
+
Returns:
true if the request was sent, false otherwise
+ +
+
+ +
+
+ + + + + + + + + +
bool QXmppMucManager::requestRoomConfiguration (const QString &  roomJid ) 
+
+
+

Request the configuration form for the given room.

+
Parameters:
+ + +
roomJid 
+
+
+
Returns:
true if the request was sent, false otherwise
+
See also:
roomConfigurationReceived()
+ +
+
+ +
+
+ + + + + + + + + +
QMap< QString, QXmppPresence > QXmppMucManager::roomParticipants (const QString &  roomJid )  const
+
+
+

Retrieves the list of participants for the given room.

+
Parameters:
+ + +
roomJid 
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool QXmppMucManager::sendInvitation (const QString &  roomJid,
const QString &  jid,
const QString &  reason 
)
+
+
+

Invite a user to a chat room.

+
Parameters:
+ + + + +
roomJid 
jid 
reason 
+
+
+
Returns:
true if the message was sent, false otherwise
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
bool QXmppMucManager::sendMessage (const QString &  roomJid,
const QString &  text 
)
+
+
+

Send a message to a chat room.

+
Parameters:
+ + + +
roomJid 
text 
+
+
+
Returns:
true if the message was sent, false otherwise
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
bool QXmppMucManager::setRoomConfiguration (const QString &  roomJid,
const QXmppDataForm &  form 
)
+
+
+

Send the configuration form for the given room.

+
Parameters:
+ + + +
roomJid 
form 
+
+
+
Returns:
true if the request was sent, false otherwise
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Classes Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on Sun Aug 22 00:44:24 2010 for QXmpp by  + +doxygen 1.6.1
+ + -- cgit v1.2.3