PrivacyListManager (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.core.session.Manager
- - rocks.xmpp.core.session.ExtensionManager
  - - rocks.xmpp.extensions.privacy.PrivacyListManager

```
public final class PrivacyListManager
extends ExtensionManager
```
This class manages privacy lists, which allow users to block communications from other users as described in XEP-0016: Privacy Lists.
2. Protocol

Server-side privacy lists enable successful completion of the following use cases:
- Retrieving one's privacy lists.
- Adding, removing, and editing one's privacy lists.
- Setting, changing, or declining active lists.
- Setting, changing, or declining the default list (i.e., the list that is active by default).
- Allowing or blocking messages based on JID, group, or subscription type (or globally).
- Allowing or blocking inbound presence notifications based on JID, group, or subscription type (or globally).
- Allowing or blocking outbound presence notifications based on JID, group, or subscription type (or globally).
- Allowing or blocking IQ stanzas based on JID, group, or subscription type (or globally).
- Allowing or blocking all communications based on JID, group, or subscription type (or globally).

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPrivacyListListener(PrivacyListListener privacyListListener)` Adds a privacy list listener.
`void`	`createOrUpdateList(PrivacyList privacyList)` Creates or edits a privacy list.
`void`	`declineActiveList()` Declines the use of any active list.
`void`	`declineDefaultList()` Declines the use of any default list.
`PrivacyList`	`getPrivacyList(String name)` Gets a privacy list.
`Collection<PrivacyList>`	`getPrivacyLists()` Gets the privacy lists.
`void`	`removeList(String name)` Removes a privacy list.
`void`	`removePrivacyListListener(PrivacyListListener privacyListListener)` Removes a previously added privacy list listener.
`void`	`setActiveList(String name)` Changes the active list currently being applied.
`void`	`setDefaultList(String name)` Change the default list (which applies to the user as a whole, not only the sending resource).

Methods inherited from class rocks.xmpp.core.session.ExtensionManager
isEnabled, setEnabled

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addPrivacyListListener
```
public void addPrivacyListListener(PrivacyListListener privacyListListener)
```
    Adds a privacy list listener.
    
    Parameters:
    privacyListListener - The listener.
    See Also:
    removePrivacyListListener(PrivacyListListener)
  - removePrivacyListListener
```
public void removePrivacyListListener(PrivacyListListener privacyListListener)
```
    Removes a previously added privacy list listener.
    
    Parameters:
    privacyListListener - The listener.
    See Also:
    addPrivacyListListener(PrivacyListListener)
  - getPrivacyLists
```
public Collection<PrivacyList> getPrivacyLists()
                                        throws XmppException
```
    Gets the privacy lists.
    
    Returns:
    The privacy lists.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.3 Retrieving One's Privacy Lists
  - getPrivacyList
```
public PrivacyList getPrivacyList(String name)
                           throws XmppException
```
    Gets a privacy list.
    
    Parameters:
    name - The privacy list name.
    
    Returns:
    The privacy list.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.3 Retrieving One's Privacy Lists
  - setActiveList
```
public void setActiveList(String name)
                   throws XmppException
```
    Changes the active list currently being applied.
    
    Parameters:
    name - The active list name.
    
    Throws:
    
    StanzaException - If the user attempts to set an active list but a list by that name does not exist, the server MUST return an <item-not-found/> stanza error to the user.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.4 Managing Active Lists
  - declineActiveList
```
public void declineActiveList()
                       throws XmppException
```
    Declines the use of any active list.
    
    Throws:
    
    StanzaException - If the request returned with an error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.4 Managing Active Lists
  - setDefaultList
```
public void setDefaultList(String name)
                    throws XmppException
```
    Change the default list (which applies to the user as a whole, not only the sending resource).
    Parameters:
    name - The list name.
    
    Throws:
    StanzaException -
    
    If the user attempts to change which list is the default list but the default list is in use by at least one connected resource other than the sending resource, the server MUST return a <conflict/> stanza error to the sending resource
    
    If the user attempts to set a default list but a list by that name does not exist, the server MUST return an <item-not-found/> stanza error to the user
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.5 Managing the Default List
  - declineDefaultList
```
public void declineDefaultList()
                        throws XmppException
```
    Declines the use of any default list.
    
    Throws:
    
    StanzaException - If one connected resource attempts to decline the use of a default list for the user as a whole but the default list currently applies to at least one other connected resource, the server MUST return a <conflict/> error to the sending resource.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.5 Managing the Default List
  - createOrUpdateList
```
public void createOrUpdateList(PrivacyList privacyList)
                        throws XmppException
```
    Creates or edits a privacy list.
    
    Parameters:
    privacyList - The privacy list.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.6 Editing a Privacy List
  - removeList
```
public void removeList(String name)
                throws XmppException
```
    Removes a privacy list.
    
    Parameters:
    name - The privacy list.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    2.8 Removing a Privacy List

Class PrivacyListManager

Method Summary

Methods inherited from class rocks.xmpp.core.session.ExtensionManager

Methods inherited from class java.lang.Object

Method Detail

addPrivacyListListener

removePrivacyListListener

getPrivacyLists

getPrivacyList

setActiveList

declineActiveList

setDefaultList

declineDefaultList

createOrUpdateList

removeList