Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-26 16:22:06 +01:00
Code Issues Releases Wiki Activity

Merge pull request #229 from fuentesj11/update-disco-doc

Browse source 
Update disco doc
This commit is contained in:
Florian Schmaus 2018-04-04 14:50:20 +02:00 committed by GitHub
commit f8f70bc5fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
documentation/extensions/disco.md
View file

@ -3,7 +3,7 @@ Service Discovery
[Back](index.md) [Back](index.md)
The service discovery extension allows to discover items and information about The service discovery extension allows one to discover items and information about
XMPP entities. Follow these links to learn how to use this extension. XMPP entities. Follow these links to learn how to use this extension.
* Manage XMPP entity features * Manage XMPP entity features
@ -92,14 +92,19 @@ ServiceDiscoveryManager that will provide information concerning a node named
ServiceDiscoveryManager.getInstanceFor(connection).setNodeInformationProvider( ServiceDiscoveryManager.getInstanceFor(connection).setNodeInformationProvider(
"http://jabber.org/protocol/muc#rooms", "http://jabber.org/protocol/muc#rooms",
new NodeInformationProvider() { new NodeInformationProvider() {
public List getNodeItems() { public List<DiscoverItems.Item> getNodeItems() {
ArrayList answer = new ArrayList(); MultiUserChatManager mucManager = MultiUserChatManager.getInstanceFor(connection);
Iterator rooms = MultiUserChat.getJoinedRooms(connection); List<DiscoverItems.Item> answer = new ArrayList<>();
Iterator<Jid> rooms = mucManager.getJoinedRooms().iterator();
while (rooms.hasNext()) { while (rooms.hasNext()) {
answer.add(new DiscoverItems.Item((String)rooms.next())); answer.add(new DiscoverItems.Item(rooms.next()));
} }
return answer; return answer;
} }
public List<String> getNodeFeatures() {...}
public List<DiscoverInfo.Identity> getNodeIdentities() {...}
public List<ExtensionElement> getNodePacketExtensions() {...}
}); });
``` ```
@ -131,7 +136,7 @@ ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(co
// This example gets the items associated with online catalog service // This example gets the items associated with online catalog service
DiscoverItems discoItems = discoManager.discoverItems("plays.shakespeare.lit"); DiscoverItems discoItems = discoManager.discoverItems("plays.shakespeare.lit");
// Get the discovered items of the queried XMPP entity // Get the discovered items of the queried XMPP entity
Iterator it = discoItems.getItems(); Iterator it = discoItems.getItems().iterator();
// Display the items of the remote XMPP entity // Display the items of the remote XMPP entity
while (it.hasNext()) { while (it.hasNext()) {
DiscoverItems.Item item = (DiscoverItems.Item) it.next(); DiscoverItems.Item item = (DiscoverItems.Item) it.next();
@ -175,7 +180,7 @@ ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(co
// This example gets the information of a conference room // This example gets the information of a conference room
DiscoverInfo discoInfo = discoManager.discoverInfo("balconyscene@plays.shakespeare.lit"); DiscoverInfo discoInfo = discoManager.discoverInfo("balconyscene@plays.shakespeare.lit");
// Get the discovered identities of the remote XMPP entity // Get the discovered identities of the remote XMPP entity
Iterator it = discoInfo.getIdentities(); Iterator it = discoInfo.getIdentities().iterator();
// Display the identities of the remote XMPP entity // Display the identities of the remote XMPP entity
while (it.hasNext()) { while (it.hasNext()) {
DiscoverInfo.Identity identity = (DiscoverInfo.Identity) it.next(); DiscoverInfo.Identity identity = (DiscoverInfo.Identity) it.next();
@ -203,7 +208,7 @@ Once you have your ServiceDiscoveryManager you will be able to publish items
to some kind of persistent storage. To publish the items of a given XMPP to some kind of persistent storage. To publish the items of a given XMPP
entity you have to first create an instance of _**DiscoverItems**_ and entity you have to first create an instance of _**DiscoverItems**_ and
configure it with the items to publish. Then you will have to send configure it with the items to publish. Then you will have to send
**publishItems(String entityID, DiscoverItems discoverItems)** to your **publishItems(Jid entityID, DiscoverItems discoverItems)** to your
_**ServiceDiscoveryManager**_ where entityID is the address of the XMPP entity _**ServiceDiscoveryManager**_ where entityID is the address of the XMPP entity
that will persist the items and discoverItems contains the items to publish. that will persist the items and discoverItems contains the items to publish.
@ -214,13 +219,17 @@ In this example we can see how to publish new items:
``` ```
// Obtain the ServiceDiscoveryManager associated with my XMPPConnection // Obtain the ServiceDiscoveryManager associated with my XMPPConnection
ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection); ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection);
// Create a DiscoverItems with the items to publish // Create a DiscoverItems with the items to publish
DiscoverItems itemsToPublish = new DiscoverItems(); DiscoverItems itemsToPublish = new DiscoverItems();
DiscoverItems.Item itemToPublish = new DiscoverItems.Item("pubsub.shakespeare.lit"); Jid jid = JidCreate.from("pubsub.shakespeare.lit");
DiscoverItems.Item itemToPublish = new DiscoverItems.Item(jid);
itemToPublish.setName("Avatar"); itemToPublish.setName("Avatar");
itemToPublish.setNode("romeo/avatar"); itemToPublish.setNode("romeo/avatar");
itemToPublish.setAction(DiscoverItems.Item.UPDATE_ACTION); itemToPublish.setAction(DiscoverItems.Item.UPDATE_ACTION);
itemsToPublish.addItem(itemToPublish); itemsToPublish.addItem(itemToPublish);
// Publish the new items by sending them to the server // Publish the new items by sending them to the server
discoManager.publishItems("host", itemsToPublish); Jid jid2 = JidCreate.from("host");
discoManager.publishItems(jid2, itemsToPublish);
``` ```