Package org.jivesoftware.openfire.entitycaps

Interface EntityCapabilitiesListener

All Known Implementing Classes:

PEPServiceManager, PubSubModule

public interface EntityCapabilitiesListener

Interface to listen for entity capabilities events. Use methods in EntityCapabilitiesManager to register for events.

Author:

Guus der Kinderen, guus.der.kinderen@gmail.com

See Also:

Method Summary

Modifier and Type	Method	Description
void	entityCapabilitiesChanged(org.xmpp.packet.JID entity, EntityCapabilities updatedEntityCapabilities, Set<String> featuresAdded, Set<String> featuresRemoved, Set<String> identitiesAdded, Set<String> identitiesRemoved)	Invoked when a change was detected in the capabilities of a particular entity.

Method Detail

entityCapabilitiesChanged

void entityCapabilitiesChanged(@Nonnull
                               org.xmpp.packet.JID entity,
                               @Nonnull
                               EntityCapabilities updatedEntityCapabilities,
                               @Nonnull
                               Set<String> featuresAdded,
                               @Nonnull
                               Set<String> featuresRemoved,
                               @Nonnull
                               Set<String> identitiesAdded,
                               @Nonnull
                               Set<String> identitiesRemoved)

Invoked when a change was detected in the capabilities of a particular entity. Apart from supplying the full entity capabilities object, each invocation will also include a the 'delta' of each capability characteristic: the features and identities that are new, or are removed, in the new capabilities, as compared to the previous capabilities for the entity. When no previous capabilities were registered for this entity, all characteristics will be new.

Parameters:

entity - The entity for which CAPS changed.

updatedEntityCapabilities - The updated capabilities.

featuresAdded - The features that are now part of the capabilities, but were not in the previous capabilities of this entity.

featuresRemoved - The features that are now no longer part of the capabilities, but were in the previous capabilities of this entity.

identitiesAdded - The identities that are now present in the capabilities, but were not in the previous capabilities of this entity.

identitiesRemoved - The identities that are no longer part of the capabilities, but were in the previous capabilities of this entity.