org.jivesoftware.smackx.muc

Class MultiUserChatManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.muc.MultiUserChatManager

public class MultiUserChatManager
extends Manager

Method Summary

Modifier and Type	Method and Description
void	addInvitationListener(InvitationListener listener) Adds a listener to invitation notifications.
void	decline(String room, String inviter, String reason) Informs the sender of an invitation that the invitee declines the invitation.
List<HostedRoom>	getHostedRooms(String serviceName) Returns a List of HostedRooms where each HostedRoom has the XMPP address of the room and the room's name.
static MultiUserChatManager	getInstanceFor(XMPPConnection connection) Get a instance of a multi user chat manager for the given connection.
Set<String>	getJoinedRooms() Returns a Set of the rooms where the user has joined.
List<String>	getJoinedRooms(String user) Returns a List of the rooms where the requested user has joined.
MultiUserChat	getMultiUserChat(String jid) Creates a multi user chat.
RoomInfo	getRoomInfo(String room) Returns the discovered information of a given room without actually having to join the room.
List<String>	getServiceNames() Returns a collection with the XMPP addresses of the Multi-User Chat services.
boolean	isServiceEnabled(String user) Returns true if the specified user supports the Multi-User Chat protocol.
void	removeInvitationListener(InvitationListener listener) Removes a listener to invitation notifications.

Methods inherited from class org.jivesoftware.smack.Manager

connection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstanceFor

public static MultiUserChatManager getInstanceFor(XMPPConnection connection)

Get a instance of a multi user chat manager for the given connection.

Parameters:

connection -

Returns:

a multi user chat manager.

getMultiUserChat

public MultiUserChat getMultiUserChat(String jid)

Creates a multi user chat. Note: no information is sent to or received from the server until you attempt to join the chat room. On some server implementations, the room will not be created until the first person joins it.

Most XMPP servers use a sub-domain for the chat service (eg chat.example.com for the XMPP server example.com). You must ensure that the room address you're trying to connect to includes the proper chat sub-domain.

Parameters:

jid - the name of the room in the form "roomName@service", where "service" is the hostname at which the multi-user chat service is running. Make sure to provide a valid JID.

isServiceEnabled

public boolean isServiceEnabled(String user)
                         throws SmackException.NoResponseException,
                                XMPPException.XMPPErrorException,
                                SmackException.NotConnectedException

Returns true if the specified user supports the Multi-User Chat protocol.

Parameters:

user - the user to check. A fully qualified xmpp ID, e.g. jdoe@example.com.

Returns:

a boolean indicating whether the specified user supports the MUC protocol.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getJoinedRooms

public Set<String> getJoinedRooms()

Returns a Set of the rooms where the user has joined. The Iterator will contain Strings where each String represents a room (e.g. room@muc.jabber.org).

Returns:

a List of the rooms where the user has joined using a given connection.

getJoinedRooms

public List<String> getJoinedRooms(String user)
                            throws SmackException.NoResponseException,
                                   XMPPException.XMPPErrorException,
                                   SmackException.NotConnectedException

Returns a List of the rooms where the requested user has joined. The Iterator will contain Strings where each String represents a room (e.g. room@muc.jabber.org).

Parameters:

user - the user to check. A fully qualified xmpp ID, e.g. jdoe@example.com.

Returns:

a List of the rooms where the requested user has joined.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getRoomInfo

public RoomInfo getRoomInfo(String room)
                     throws SmackException.NoResponseException,
                            XMPPException.XMPPErrorException,
                            SmackException.NotConnectedException

Returns the discovered information of a given room without actually having to join the room. The server will provide information only for rooms that are public.

Parameters:

room - the name of the room in the form "roomName@service" of which we want to discover its information.

Returns:

the discovered information of a given room without actually having to join the room.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getServiceNames

public List<String> getServiceNames()
                             throws SmackException.NoResponseException,
                                    XMPPException.XMPPErrorException,
                                    SmackException.NotConnectedException

Returns a collection with the XMPP addresses of the Multi-User Chat services.

Returns:

a collection with the XMPP addresses of the Multi-User Chat services.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getHostedRooms

public List<HostedRoom> getHostedRooms(String serviceName)
                                throws SmackException.NoResponseException,
                                       XMPPException.XMPPErrorException,
                                       SmackException.NotConnectedException

Returns a List of HostedRooms where each HostedRoom has the XMPP address of the room and the room's name. Once discovered the rooms hosted by a chat service it is possible to discover more detailed room information or join the room.

Parameters:

serviceName - the service that is hosting the rooms to discover.

Returns:

a collection of HostedRooms.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

decline

public void decline(String room,
                    String inviter,
                    String reason)
             throws SmackException.NotConnectedException

Informs the sender of an invitation that the invitee declines the invitation. The rejection will be sent to the room which in turn will forward the rejection to the inviter.

Parameters:

room - the room that sent the original invitation.

inviter - the inviter of the declined invitation.

reason - the reason why the invitee is declining the invitation.

Throws:

SmackException.NotConnectedException

addInvitationListener

public void addInvitationListener(InvitationListener listener)

Adds a listener to invitation notifications. The listener will be fired anytime an invitation is received.

Parameters:

listener - an invitation listener.

removeInvitationListener

public void removeInvitationListener(InvitationListener listener)

Removes a listener to invitation notifications. The listener will be fired anytime an invitation is received.

Parameters:

listener - an invitation listener.