com.quickblox.chat

Class QBPrivacyListsManager

java.lang.Object

Manager

com.quickblox.chat.QBPrivacyListsManager

public class QBPrivacyListsManager
extends Manager

A PrivacyListManager is used by XMPP clients to block or allow communications from other users. Use the manager to:

• Retrieve privacy lists.
• Add, remove, and edit privacy list.
• Apply or decline privacy list.

Method Summary

Modifier and Type	Method and Description
void	addPrivacyListListener(QBPrivacyListListener listener) Adds a listener that will be notified of any new update in the user privacy communication.
void	applyPrivacyList(QBPrivacyList list) Applies a privacy list
void	applyPrivacyList(java.lang.String listName) Applies a privacy list
void	createPrivacyList(QBPrivacyList list) Create a new privacy list.
void	declineActiveList() Deprecated. in version 3.6.0. Use declinePrivacyList()
void	declineDefaultList() Deprecated. in version 3.6.0. Use declinePrivacyList()
void	declinePrivacyList() Declines the use of privacy list.
void	deletePrivacyList(QBPrivacyList list) Remove a privacy list.
void	deletePrivacyList(java.lang.String name) Remove a privacy list.
QBPrivacyList	getPrivacyList(java.lang.String listName) Answer the privacy list items under listName with the allowed and blocked permissions.
java.util.Collection<QBPrivacyListListener>	getPrivacyListListeners() Returns an unmodifiable collection of all listeners currently registered with this manager.
java.util.List<QBPrivacyList>	getPrivacyLists() Answer every privacy list with the allowed and blocked permissions.
void	removePrivacyListListener(QBPrivacyListListener listener) Removes a listener, it will no longer be notified of new updates in the user privacy communication.
void	setPrivacyList(QBPrivacyList list) Deprecated. in version 3.6.0. Use createPrivacyList(QBPrivacyList)
void	setPrivacyListAsActive(QBPrivacyList list) Deprecated. in version 3.6.0. Use applyPrivacyList(QBPrivacyList)
void	setPrivacyListAsActive(java.lang.String name) Deprecated. in version 3.6.0. Use applyPrivacyList(String)
void	setPrivacyListAsDefault(QBPrivacyList list) Deprecated. in version 3.6.0. Use applyPrivacyList(QBPrivacyList)
void	setPrivacyListAsDefault(java.lang.String name) Deprecated. in version 3.6.0. Use applyPrivacyList(String)

Methods inherited from class java.lang.Object

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

Method Detail

addPrivacyListListener

public void addPrivacyListListener(QBPrivacyListListener listener)

Adds a listener that will be notified of any new update in the user privacy communication.

Parameters:

listener - The QBPrivateChatManagerListener instance.

removePrivacyListListener

public void removePrivacyListListener(QBPrivacyListListener listener)

Removes a listener, it will no longer be notified of new updates in the user privacy communication.

Parameters:

listener - The listener that is being removed

getPrivacyListListeners

public java.util.Collection<QBPrivacyListListener> getPrivacyListListeners()

Returns an unmodifiable collection of all listeners currently registered with this manager.

getPrivacyLists

public java.util.List<QBPrivacyList> getPrivacyLists()
                                              throws SmackException.NotConnectedException,
                                                     XMPPException.XMPPErrorException,
                                                     SmackException.NoResponseException

Answer every privacy list with the allowed and blocked permissions.

Returns:

An array of QBPrivacyList

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

getPrivacyList

public QBPrivacyList getPrivacyList(java.lang.String listName)
                             throws SmackException.NotConnectedException,
                                    XMPPException.XMPPErrorException,
                                    SmackException.NoResponseException

Answer the privacy list items under listName with the allowed and blocked permissions.

Parameters:

listName - The name of the list to get the allowed and blocked permissions.

Returns:

a privacy list under the list listName.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

setPrivacyList

@Deprecated
public void setPrivacyList(QBPrivacyList list)
                                throws SmackException.NotConnectedException,
                                       XMPPException.XMPPErrorException,
                                       SmackException.NoResponseException,
                                       java.lang.IllegalArgumentException

Deprecated. in version 3.6.0. Use createPrivacyList(QBPrivacyList)

Create a new privacy list.

Parameters:

list - The new privacy list instance

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

java.lang.IllegalArgumentException - when QBPrivacyList or QBPrivacyList.items are null or QBPrivacyList.items.size is 0

createPrivacyList

public void createPrivacyList(QBPrivacyList list)
                       throws SmackException.NotConnectedException,
                              XMPPException.XMPPErrorException,
                              SmackException.NoResponseException,
                              java.lang.IllegalArgumentException

Create a new privacy list.

Parameters:

list - The new privacy list instance

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

java.lang.IllegalArgumentException - when QBPrivacyList or QBPrivacyList.items are null or QBPrivacyList.items.size is 0

deletePrivacyList

public void deletePrivacyList(QBPrivacyList list)
                       throws SmackException.NotConnectedException,
                              XMPPException.XMPPErrorException,
                              SmackException.NoResponseException

Remove a privacy list.

Parameters:

list - The instance of a privacy list to remove

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

deletePrivacyList

public void deletePrivacyList(java.lang.String name)
                       throws SmackException.NotConnectedException,
                              XMPPException.XMPPErrorException,
                              SmackException.NoResponseException

Remove a privacy list.

Parameters:

name - The name of a privacy list to remove

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

declineActiveList

@Deprecated
public void declineActiveList()
                                   throws SmackException.NotConnectedException,
                                          XMPPException.XMPPErrorException,
                                          SmackException.NoResponseException

Deprecated. in version 3.6.0. Use declinePrivacyList()

Declines the use of active list.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

declineDefaultList

@Deprecated
public void declineDefaultList()
                                    throws SmackException.NotConnectedException,
                                           XMPPException.XMPPErrorException,
                                           SmackException.NoResponseException

Deprecated. in version 3.6.0. Use declinePrivacyList()

Declines the use of default list.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

declinePrivacyList

public void declinePrivacyList()
                        throws SmackException.NotConnectedException,
                               XMPPException.XMPPErrorException,
                               SmackException.NoResponseException

Declines the use of privacy list.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

Since:

3.6.0

setPrivacyListAsActive

@Deprecated
public void setPrivacyListAsActive(QBPrivacyList list)
                                        throws SmackException.NotConnectedException,
                                               XMPPException.XMPPErrorException,
                                               SmackException.NoResponseException

Deprecated. in version 3.6.0. Use applyPrivacyList(QBPrivacyList)

Sets a privacy list as active.

Parameters:

list - The instance of a privacy list to set as active

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

setPrivacyListAsActive

@Deprecated
public void setPrivacyListAsActive(java.lang.String name)
                                        throws SmackException.NotConnectedException,
                                               XMPPException.XMPPErrorException,
                                               SmackException.NoResponseException

Deprecated. in version 3.6.0. Use applyPrivacyList(String)

Sets a privacy list as active.

Parameters:

name - The name of a privacy list to set as active

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

setPrivacyListAsDefault

@Deprecated
public void setPrivacyListAsDefault(QBPrivacyList list)
                                         throws SmackException.NotConnectedException,
                                                XMPPException.XMPPErrorException,
                                                SmackException.NoResponseException

Deprecated. in version 3.6.0. Use applyPrivacyList(QBPrivacyList)

Sets a privacy list as default.

Parameters:

list - The instance of a privacy list to set as default

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

setPrivacyListAsDefault

@Deprecated
public void setPrivacyListAsDefault(java.lang.String name)
                                         throws SmackException.NotConnectedException,
                                                XMPPException.XMPPErrorException,
                                                SmackException.NoResponseException

Deprecated. in version 3.6.0. Use applyPrivacyList(String)

Sets a privacy list as default.

Parameters:

name - The name of a privacy list to set as default

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

applyPrivacyList

public void applyPrivacyList(QBPrivacyList list)
                      throws SmackException.NotConnectedException,
                             XMPPException.XMPPErrorException,
                             SmackException.NoResponseException

Applies a privacy list

Parameters:

list - The instance of a privacy list to apply

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

Since:

3.6.0

applyPrivacyList

public void applyPrivacyList(java.lang.String listName)
                      throws SmackException.NotConnectedException,
                             XMPPException.XMPPErrorException,
                             SmackException.NoResponseException

Applies a privacy list

Parameters:

listName - The name of a privacy list to apply

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

Since:

3.6.0