Package org.jivesoftware.smackx.muclight

Class MultiUserChatLightManager

  • public final class MultiUserChatLightManager
extends org.jivesoftware.smack.Manager
    Multi-User Chat Light manager class.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void blockRoom​(org.jxmpp.jid.DomainBareJid mucLightService, org.jxmpp.jid.Jid roomJid)
      Block a room.
      void blockRooms​(org.jxmpp.jid.DomainBareJid mucLightService, java.util.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, java.util.List<org.jxmpp.jid.Jid> usersJids)
      Block users.
      static MultiUserChatLightManager getInstanceFor​(org.jivesoftware.smack.XMPPConnection connection)
      Get a instance of a MUC Light manager for the given connection.
      java.util.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.
      java.util.List<org.jxmpp.jid.Jid> getOccupiedRooms​(org.jxmpp.jid.DomainBareJid mucLightService)
      Returns a List of the rooms the user occupies.
      java.util.List<org.jxmpp.jid.Jid> getRoomsBlocked​(org.jxmpp.jid.DomainBareJid mucLightService)
      Get rooms blocked.
      java.util.List<org.jxmpp.jid.Jid> getUsersAndRoomsBlocked​(org.jxmpp.jid.DomainBareJid mucLightService)
      Get users and rooms blocked.
      java.util.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, java.util.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, java.util.List<org.jxmpp.jid.Jid> usersJids)
      Unblock users.

      • Methods inherited from class org.jivesoftware.smack.Manager

        connection, getAuthenticatedConnectionOrThrow, schedule, schedule, scheduleBlocking

      • 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​(org.jivesoftware.smack.XMPPConnection connection)
        Get a instance of a MUC Light manager for the given connection.
        Parameters:
        connection - TODO javadoc me please
        Returns:
        a MUCLight manager.

      • getMultiUserChatLight

        public MultiUserChatLight getMultiUserChatLight​(org.jxmpp.jid.EntityBareJid jid)
        Obtain the MUC Light.
        Parameters:
        jid - TODO javadoc me please
        Returns:
        the MUCLight.

      • isFeatureSupported

        public boolean isFeatureSupported​(org.jxmpp.jid.DomainBareJid mucLightService)
                           throws org.jivesoftware.smack.SmackException.NoResponseException,
                                  org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                  org.jivesoftware.smack.SmackException.NotConnectedException,
                                  java.lang.InterruptedException
        Returns true if Multi-User Chat Light feature is supported by the server.
        Parameters:
        mucLightService - TODO javadoc me please
        Returns:
        true if Multi-User Chat Light feature is supported by the server.
        Throws:
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • getOccupiedRooms

        public java.util.List<org.jxmpp.jid.Jid> getOccupiedRooms​(org.jxmpp.jid.DomainBareJid mucLightService)
                                                   throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                          org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                          org.jivesoftware.smack.SmackException.NotConnectedException,
                                                          java.lang.InterruptedException
        Returns a List of the rooms the user occupies.
        Parameters:
        mucLightService - TODO javadoc me please
        Returns:
        a List of the rooms the user occupies.
        Throws:
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • getLocalServices

        public java.util.List<org.jxmpp.jid.DomainBareJid> getLocalServices()
                                                             throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                                    org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                                    org.jivesoftware.smack.SmackException.NotConnectedException,
                                                                    java.lang.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:
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • getUsersAndRoomsBlocked

        public java.util.List<org.jxmpp.jid.Jid> getUsersAndRoomsBlocked​(org.jxmpp.jid.DomainBareJid mucLightService)
                                                          throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                                 org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                                 org.jivesoftware.smack.SmackException.NotConnectedException,
                                                                 java.lang.InterruptedException
        Get users and rooms blocked.
        Parameters:
        mucLightService - TODO javadoc me please
        Returns:
        the list of users and rooms blocked
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • getRoomsBlocked

        public java.util.List<org.jxmpp.jid.Jid> getRoomsBlocked​(org.jxmpp.jid.DomainBareJid mucLightService)
                                                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                         org.jivesoftware.smack.SmackException.NotConnectedException,
                                                         java.lang.InterruptedException
        Get rooms blocked.
        Parameters:
        mucLightService - TODO javadoc me please
        Returns:
        the list of rooms blocked
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • getUsersBlocked

        public java.util.List<org.jxmpp.jid.Jid> getUsersBlocked​(org.jxmpp.jid.DomainBareJid mucLightService)
                                                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                         org.jivesoftware.smack.SmackException.NotConnectedException,
                                                         java.lang.InterruptedException
        Get users blocked.
        Parameters:
        mucLightService - TODO javadoc me please
        Returns:
        the list of users blocked
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • blockRoom

        public void blockRoom​(org.jxmpp.jid.DomainBareJid mucLightService,
                      org.jxmpp.jid.Jid roomJid)
               throws org.jivesoftware.smack.SmackException.NoResponseException,
                      org.jivesoftware.smack.XMPPException.XMPPErrorException,
                      org.jivesoftware.smack.SmackException.NotConnectedException,
                      java.lang.InterruptedException
        Block a room.
        Parameters:
        mucLightService - TODO javadoc me please
        roomJid - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • blockRooms

        public void blockRooms​(org.jxmpp.jid.DomainBareJid mucLightService,
                       java.util.List<org.jxmpp.jid.Jid> roomsJids)
                throws org.jivesoftware.smack.SmackException.NoResponseException,
                       org.jivesoftware.smack.XMPPException.XMPPErrorException,
                       org.jivesoftware.smack.SmackException.NotConnectedException,
                       java.lang.InterruptedException
        Block rooms.
        Parameters:
        mucLightService - TODO javadoc me please
        roomsJids - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • blockUser

        public void blockUser​(org.jxmpp.jid.DomainBareJid mucLightService,
                      org.jxmpp.jid.Jid userJid)
               throws org.jivesoftware.smack.SmackException.NoResponseException,
                      org.jivesoftware.smack.XMPPException.XMPPErrorException,
                      org.jivesoftware.smack.SmackException.NotConnectedException,
                      java.lang.InterruptedException
        Block a user.
        Parameters:
        mucLightService - TODO javadoc me please
        userJid - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • blockUsers

        public void blockUsers​(org.jxmpp.jid.DomainBareJid mucLightService,
                       java.util.List<org.jxmpp.jid.Jid> usersJids)
                throws org.jivesoftware.smack.SmackException.NoResponseException,
                       org.jivesoftware.smack.XMPPException.XMPPErrorException,
                       org.jivesoftware.smack.SmackException.NotConnectedException,
                       java.lang.InterruptedException
        Block users.
        Parameters:
        mucLightService - TODO javadoc me please
        usersJids - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • unblockRoom

        public void unblockRoom​(org.jxmpp.jid.DomainBareJid mucLightService,
                        org.jxmpp.jid.Jid roomJid)
                 throws org.jivesoftware.smack.SmackException.NoResponseException,
                        org.jivesoftware.smack.XMPPException.XMPPErrorException,
                        org.jivesoftware.smack.SmackException.NotConnectedException,
                        java.lang.InterruptedException
        Unblock a room.
        Parameters:
        mucLightService - TODO javadoc me please
        roomJid - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • unblockRooms

        public void unblockRooms​(org.jxmpp.jid.DomainBareJid mucLightService,
                         java.util.List<org.jxmpp.jid.Jid> roomsJids)
                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                         org.jivesoftware.smack.SmackException.NotConnectedException,
                         java.lang.InterruptedException
        Unblock rooms.
        Parameters:
        mucLightService - TODO javadoc me please
        roomsJids - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • unblockUser

        public void unblockUser​(org.jxmpp.jid.DomainBareJid mucLightService,
                        org.jxmpp.jid.Jid userJid)
                 throws org.jivesoftware.smack.SmackException.NoResponseException,
                        org.jivesoftware.smack.XMPPException.XMPPErrorException,
                        org.jivesoftware.smack.SmackException.NotConnectedException,
                        java.lang.InterruptedException
        Unblock a user.
        Parameters:
        mucLightService - TODO javadoc me please
        userJid - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.

      • unblockUsers

        public void unblockUsers​(org.jxmpp.jid.DomainBareJid mucLightService,
                         java.util.List<org.jxmpp.jid.Jid> usersJids)
                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                         org.jivesoftware.smack.SmackException.NotConnectedException,
                         java.lang.InterruptedException
        Unblock users.
        Parameters:
        mucLightService - TODO javadoc me please
        usersJids - TODO javadoc me please
        Throws:
        org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.
        org.jivesoftware.smack.XMPPException.XMPPErrorException - if there was an XMPP error returned.
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.