org.jivesoftware.smackx.muclight

Class MultiUserChatLightManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.muclight.MultiUserChatLightManager

public final class MultiUserChatLightManager
extends Manager

Multi-User Chat Light manager class.

Method Summary

Modifier and Type	Method and Description
void	blockRoom(org.jxmpp.jid.DomainBareJid mucLightService, org.jxmpp.jid.Jid roomJid) Block a room.
void	blockRooms(org.jxmpp.jid.DomainBareJid mucLightService, List<org.jxmpp.jid.Jid> roomsJids) Block rooms.
void	blockUser(org.jxmpp.jid.DomainBareJid mucLightService, org.jxmpp.jid.Jid userJid) Block a user.
void	blockUsers(org.jxmpp.jid.DomainBareJid mucLightService, List<org.jxmpp.jid.Jid> usersJids) Block users.
static MultiUserChatLightManager	getInstanceFor(XMPPConnection connection) Get a instance of a MUC Light manager for the given connection.
List<org.jxmpp.jid.DomainBareJid>	getLocalServices() Returns a collection with the XMPP addresses of the MUC Light services.
MultiUserChatLight	getMultiUserChatLight(org.jxmpp.jid.EntityBareJid jid) Obtain the MUC Light.
List<org.jxmpp.jid.Jid>	getOccupiedRooms(org.jxmpp.jid.DomainBareJid mucLightService) Returns a List of the rooms the user occupies.
List<org.jxmpp.jid.Jid>	getRoomsBlocked(org.jxmpp.jid.DomainBareJid mucLightService) Get rooms blocked.
List<org.jxmpp.jid.Jid>	getUsersAndRoomsBlocked(org.jxmpp.jid.DomainBareJid mucLightService) Get users and rooms blocked.
List<org.jxmpp.jid.Jid>	getUsersBlocked(org.jxmpp.jid.DomainBareJid mucLightService) Get users blocked.
boolean	isFeatureSupported(org.jxmpp.jid.DomainBareJid mucLightService) Returns true if Multi-User Chat Light feature is supported by the server.
void	unblockRoom(org.jxmpp.jid.DomainBareJid mucLightService, org.jxmpp.jid.Jid roomJid) Unblock a room.
void	unblockRooms(org.jxmpp.jid.DomainBareJid mucLightService, List<org.jxmpp.jid.Jid> roomsJids) Unblock rooms.
void	unblockUser(org.jxmpp.jid.DomainBareJid mucLightService, org.jxmpp.jid.Jid userJid) Unblock a user.
void	unblockUsers(org.jxmpp.jid.DomainBareJid mucLightService, List<org.jxmpp.jid.Jid> usersJids) Unblock users.

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static MultiUserChatLightManager getInstanceFor(XMPPConnection connection)

Get a instance of a MUC Light manager for the given connection.

Parameters:

connection -

Returns:

a MUCLight manager.

getMultiUserChatLight

public MultiUserChatLight getMultiUserChatLight(org.jxmpp.jid.EntityBareJid jid)

Obtain the MUC Light.

Parameters:

jid -

Returns:

the MUCLight.

isFeatureSupported

public boolean isFeatureSupported(org.jxmpp.jid.DomainBareJid mucLightService)
                           throws SmackException.NoResponseException,
                                  XMPPException.XMPPErrorException,
                                  SmackException.NotConnectedException,
                                  InterruptedException

Returns true if Multi-User Chat Light feature is supported by the server.

Parameters:

mucLightService -

Returns:

true if Multi-User Chat Light feature is supported by the server.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

InterruptedException

getOccupiedRooms

public List<org.jxmpp.jid.Jid> getOccupiedRooms(org.jxmpp.jid.DomainBareJid mucLightService)
                                         throws SmackException.NoResponseException,
                                                XMPPException.XMPPErrorException,
                                                SmackException.NotConnectedException,
                                                InterruptedException

Returns a List of the rooms the user occupies.

Parameters:

mucLightService -

Returns:

a List of the rooms the user occupies.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

InterruptedException

getLocalServices

public List<org.jxmpp.jid.DomainBareJid> getLocalServices()
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException

Returns a collection with the XMPP addresses of the MUC Light services.

Returns:

a collection with the XMPP addresses of the MUC Light services.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

InterruptedException

getUsersAndRoomsBlocked

public List<org.jxmpp.jid.Jid> getUsersAndRoomsBlocked(org.jxmpp.jid.DomainBareJid mucLightService)
                                                throws SmackException.NoResponseException,
                                                       XMPPException.XMPPErrorException,
                                                       SmackException.NotConnectedException,
                                                       InterruptedException

Get users and rooms blocked.

Parameters:

mucLightService -

Returns:

the list of users and rooms blocked

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

getRoomsBlocked

public List<org.jxmpp.jid.Jid> getRoomsBlocked(org.jxmpp.jid.DomainBareJid mucLightService)
                                        throws SmackException.NoResponseException,
                                               XMPPException.XMPPErrorException,
                                               SmackException.NotConnectedException,
                                               InterruptedException

Get rooms blocked.

Parameters:

mucLightService -

Returns:

the list of rooms blocked

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

getUsersBlocked

public List<org.jxmpp.jid.Jid> getUsersBlocked(org.jxmpp.jid.DomainBareJid mucLightService)
                                        throws SmackException.NoResponseException,
                                               XMPPException.XMPPErrorException,
                                               SmackException.NotConnectedException,
                                               InterruptedException

Get users blocked.

Parameters:

mucLightService -

Returns:

the list of users blocked

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

blockRoom

public void blockRoom(org.jxmpp.jid.DomainBareJid mucLightService,
                      org.jxmpp.jid.Jid roomJid)
               throws SmackException.NoResponseException,
                      XMPPException.XMPPErrorException,
                      SmackException.NotConnectedException,
                      InterruptedException

Block a room.

Parameters:

mucLightService -

roomJid -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

blockRooms

public void blockRooms(org.jxmpp.jid.DomainBareJid mucLightService,
                       List<org.jxmpp.jid.Jid> roomsJids)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException,
                       InterruptedException

Block rooms.

Parameters:

mucLightService -

roomsJids -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

blockUser

public void blockUser(org.jxmpp.jid.DomainBareJid mucLightService,
                      org.jxmpp.jid.Jid userJid)
               throws SmackException.NoResponseException,
                      XMPPException.XMPPErrorException,
                      SmackException.NotConnectedException,
                      InterruptedException

Block a user.

Parameters:

mucLightService -

userJid -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

blockUsers

public void blockUsers(org.jxmpp.jid.DomainBareJid mucLightService,
                       List<org.jxmpp.jid.Jid> usersJids)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException,
                       InterruptedException

Block users.

Parameters:

mucLightService -

usersJids -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

unblockRoom

public void unblockRoom(org.jxmpp.jid.DomainBareJid mucLightService,
                        org.jxmpp.jid.Jid roomJid)
                 throws SmackException.NoResponseException,
                        XMPPException.XMPPErrorException,
                        SmackException.NotConnectedException,
                        InterruptedException

Unblock a room.

Parameters:

mucLightService -

roomJid -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

unblockRooms

public void unblockRooms(org.jxmpp.jid.DomainBareJid mucLightService,
                         List<org.jxmpp.jid.Jid> roomsJids)
                  throws SmackException.NoResponseException,
                         XMPPException.XMPPErrorException,
                         SmackException.NotConnectedException,
                         InterruptedException

Unblock rooms.

Parameters:

mucLightService -

roomsJids -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

unblockUser

public void unblockUser(org.jxmpp.jid.DomainBareJid mucLightService,
                        org.jxmpp.jid.Jid userJid)
                 throws SmackException.NoResponseException,
                        XMPPException.XMPPErrorException,
                        SmackException.NotConnectedException,
                        InterruptedException

Unblock a user.

Parameters:

mucLightService -

userJid -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException

unblockUsers

public void unblockUsers(org.jxmpp.jid.DomainBareJid mucLightService,
                         List<org.jxmpp.jid.Jid> usersJids)
                  throws SmackException.NoResponseException,
                         XMPPException.XMPPErrorException,
                         SmackException.NotConnectedException,
                         InterruptedException

Unblock users.

Parameters:

mucLightService -

usersJids -

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

InterruptedException