Smack/documentation/extensions/blockingcommand.md

77 lines
1.2 KiB
Markdown

Blocking Command
================
[Back](index.md)
Allows one to manage communications blocking.
* Check push notifications support
* Get blocking list
* Block contact
* Unblock contact
* Unblock all
* Check if a message has a blocked error
**XEP related:** [XEP-0191](http://xmpp.org/extensions/xep-0191.html)
Get an instance of Blocking Command Manager
-------------------------------------------
```
BlockingCommandManager blockingCommandManager = BlockingCommandManager.getInstanceFor(connection);
```
Check blocking command support
------------------------------
```
boolean isSupported = blockingCommandManager.isSupportedByServer();
```
Get block list
--------------
```
List<Jid> blockList = blockingCommandManager.getBlockList();
```
Block contact
-------------
```
blockingCommandManager.blockContacts(jids);
```
*jids* is a `java.util.List<Jid>`
Unblock contact
---------------
```
blockingCommandManager.unblockContacts(jids);
```
*jids* is a `java.util.List<Jid>`
Unblock all
-----------
```
blockingCommandManager.unblockAll();
```
Check if a message has a blocked error
--------------------------------------
```
BlockedErrorExtension.isInside(message));
```
*message* is a `Message`