Package com.vaadin.collaborationengine

Interface Summary

Interface	Description
ActivationHandler	Defines when to execute the connection callback
CollaborationAvatarGroup.ImageProvider	Callback for creating a stream resource with the image for a specific user.
CollaborationList	A list that is shared between multiple users.
CollaborationMap	A map that is shared between multiple users.
CollaborationMessagePersister	Persister of CollaborationMessage items, which enables to read and write messages from/to a backend, for example a database.
CollaborationMessageSubmitter	Submitter of messages.
CollaborationMessageSubmitter.ActivationContext	The activation context of a CollaborationMessageSubmitter.
ConnectionContext	Defining how a topic connection should handle incoming changes.
HasExpirationTimeout	Common interface to be implemented by types holding data associated to a topic, which provides methods to set an expiration timeout on the data which will be cleared after the timeout has passed since the last connection to the topic has been closed.
LicenseEventHandler	Event handler that gets notified on license events.
ListSubscriber	Event handler that gets notified for changes to collaboration lists.
MapSubscriber	Event handler that gets notified for changes to collaboration maps.
TopicConnectionRegistration.ConnectionFailedAction	An action for handling a failed topic connection.

Class Summary

Class	Description
AbstractMapChange	A change of the map data in a Topic
AccessResponse	Response object when access to Collaboration Engine is requested for a user.
CollaborationAvatarGroup	Extension of the AvatarGroup component which integrates with the CollaborationEngine.
CollaborationBinder<BEAN>	Extension of Binder for creating collaborative forms with CollaborationEngine.
CollaborationBinder.CollaborationBindingBuilderImpl<BEAN,FIELDVALUE,TARGET>
CollaborationBinderUtil	Utility methods for CollaborationBinder.
CollaborationEngine	CollaborationEngine is an API for creating collaborative experiences in Vaadin applications.
CollaborationEngineConfiguration	Configuration object for CollaborationEngine.
CollaborationEngineServiceInitListener	A VaadinServiceInitListener which uses the Instantiator to find whether an instance of CollaborationEngineConfiguration is provided as a bean in the current environment, using that instance if found.
CollaborationMessage	Message of a CollaborationMessageList.
CollaborationMessageInput	Extension of the MessageInput component which integrates with the CollaborationMessageList.
CollaborationMessageList	Extension of the MessageList component which integrates with the CollaborationEngine.
CollaborationMessagePersister.FetchQuery	A query to fetch messages from a backend.
CollaborationMessagePersister.PersistRequest	A request to persist messages to a backend.
ComponentConnectionContext	A connection context based on the attach state of a set of component instances.
JsonUtil
LicenseEvent	Event that is fired during license lifecycle, e.g.
ListChangeEvent	Event that is fired when the value in a collaboration list changes.
MapChange	A single change that is emitted from the map data of a Topic.
MapChangeEvent	Event that is fired when the value in a collaboration map changes.
SystemUserInfo	A UserInfo for non-interaction thread.
TopicConnection	API for sending and subscribing to updates between clients collaborating on the same collaboration topic.
TopicConnectionRegistration	A registration for configuring or removing a topic connection that is opened with Collaboration Engine.
TopicConnectionRegistration.ConnectionFailedEvent	An event that is fired when the topic connection fails.
UserInfo	User information of a collaborating user, used with various features of the collaboration engine.

Enum Summary

Enum	Description
LicenseEvent.LicenseEventType	The license event type.

Exception Summary

Exception	Description
JsonConversionException	Thrown when unable to convert back and forth between a Java object instance and a Jackson JsonNode instance.