List of all members.
Signals |
void | invitationReceived (const QString &roomJid, const QString &inviter, const QString &reason) |
void | roomConfigurationReceived (const QString &roomJid, const QXmppDataForm &configuration) |
| This signal is emitted when the configuration form for a chat room is received.
|
void | roomPermissionsReceived (const QString &roomJid, const QList< QXmppMucAdminIq::Item > &permissions) |
| This signal is emitted when the permissions for a chat room are received.
|
void | roomParticipantChanged (const QString &roomJid, const QString &nickName) |
Public Member Functions |
bool | joinRoom (const QString &roomJid, const QString &nickName, const QString &password=QString()) |
bool | leaveRoom (const QString &roomJid) |
bool | requestRoomConfiguration (const QString &roomJid) |
bool | setRoomConfiguration (const QString &roomJid, const QXmppDataForm &form) |
bool | requestRoomPermissions (const QString &roomJid) |
bool | setRoomSubject (const QString &roomJid, const QString &subject) |
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.
To make use of this manager, you need to instantiate it and load it into the QXmppClient instance as follows:
Member Function Documentation
void QXmppMucManager::invitationReceived |
( |
const QString & |
roomJid, |
|
|
const QString & |
inviter, |
|
|
const QString & |
reason | |
|
) |
| | [signal] |
This signal is emitted when an invitation to a chat room is received.
bool QXmppMucManager::joinRoom |
( |
const QString & |
roomJid, |
|
|
const QString & |
nickName, |
|
|
const QString & |
password = QString() | |
|
) |
| | |
Joins the given chat room with the requested nickname.
- Parameters:
-
| roomJid | |
| nickName | |
| password | an optional password if the room is password-protected |
- Returns:
- true if the request was sent, false otherwise
bool QXmppMucManager::leaveRoom |
( |
const QString & |
roomJid |
) |
|
Leaves the given chat room.
- Parameters:
-
- Returns:
- true if the request was sent, false otherwise
bool QXmppMucManager::requestRoomConfiguration |
( |
const QString & |
roomJid |
) |
|
Request the configuration form for the given room.
- Parameters:
-
- Returns:
- true if the request was sent, false otherwise
- See also:
- roomConfigurationReceived()
bool QXmppMucManager::requestRoomPermissions |
( |
const QString & |
roomJid |
) |
|
Request the room's permissions.
- Parameters:
-
- Returns:
- true if the request was sent, false otherwise
void QXmppMucManager::roomParticipantChanged |
( |
const QString & |
roomJid, |
|
|
const QString & |
nickName | |
|
) |
| | [signal] |
This signal is emitted when a room participant's presence changed.
- See also:
- roomParticipants()
QMap< QString, QXmppPresence > QXmppMucManager::roomParticipants |
( |
const QString & |
roomJid |
) |
const |
Retrieves the list of participants for the given room.
- Parameters:
-
bool QXmppMucManager::sendInvitation |
( |
const QString & |
roomJid, |
|
|
const QString & |
jid, |
|
|
const QString & |
reason | |
|
) |
| | |
Invite a user to a chat room.
- Parameters:
-
- 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:
-
- 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:
-
- Returns:
- true if the request was sent, false otherwise
bool QXmppMucManager::setRoomSubject |
( |
const QString & |
roomJid, |
|
|
const QString & |
subject | |
|
) |
| | |
Sets the subject for the given room.
- Parameters:
-
- Returns:
- true if the request was sent, false otherwise
The documentation for this class was generated from the following files: