rocks.xmpp.extensions.blocking

Class BlockingManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.extensions.blocking.BlockingManager

public final class BlockingManager
extends Manager

This manager allows to block communications with contacts.

Enabling or disabling this manager has no effect, because blocking is done on server side.

This class is thread-safe.

Method Summary

Modifier and Type	Method and Description
void	addBlockingListener(Consumer<BlockingEvent> blockingListener) Adds a blocking listener, which allows to listen for block and unblock pushes.
void	blockContact(rocks.xmpp.addr.Jid... jids) Blocks communications with contacts.
Collection<rocks.xmpp.addr.Jid>	getBlockedContacts() Retrieves the blocked contacts.
void	removeBlockingListener(Consumer<BlockingEvent> blockingListener) Removes a previously added blocking listener.
void	unblockContact(rocks.xmpp.addr.Jid... jids) Unblocks communications with specific contacts or with all contacts.

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

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Method Detail

addBlockingListener

public final void addBlockingListener(Consumer<BlockingEvent> blockingListener)

Adds a blocking listener, which allows to listen for block and unblock pushes.

Parameters:

blockingListener - The listener.

See Also:

removeBlockingListener(Consumer)

removeBlockingListener

public final void removeBlockingListener(Consumer<BlockingEvent> blockingListener)

Removes a previously added blocking listener.

Parameters:

blockingListener - The listener.

See Also:

addBlockingListener(Consumer)

getBlockedContacts

public final Collection<rocks.xmpp.addr.Jid> getBlockedContacts()
                                                         throws XmppException

Retrieves the blocked contacts.

Returns:

The block list.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

See Also:

3.2 User Retrieves Block List

blockContact

public final void blockContact(rocks.xmpp.addr.Jid... jids)
                        throws XmppException

Blocks communications with contacts.

Parameters:

jids - The contacts.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

See Also:

3.3 User Blocks Contact

unblockContact

public final void unblockContact(rocks.xmpp.addr.Jid... jids)
                          throws XmppException

Unblocks communications with specific contacts or with all contacts. If you want to unblock all communications, pass no arguments to this method.

Parameters:

jids - The contacts.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

See Also:

3.4 User Unblocks Contact, 3.5 User Unblocks All Contacts