We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.collaborationengine.
Package com.vaadin.collaborationengine
package com.vaadin.collaborationengine
-
ClassDescription
The common abstract superclass of Collaboration Managers.
The callback executed when the manager is activated, i.e.
Response object when access to Collaboration Engine is requested for a user.
Allows dispatching actions to be executed in background.
Defines when to execute the connection callback
The interface between a cluster backend and Collaboration Engine.
This exception is thrown by the {@link EventLog::subscribe()} method if the provided
UUIDdoes not exist in the log.A strictly ordered log of submitted events.
The
Snapshotclass is used to submit and retrieve a snapshot payload using the {@link Backend::replaceSnapshot()} and {@link Backend::loadLatestSnapshot()} methods.Exception thrown if the feature-flag for the
BackendAPI is not enabled.Extension of the
AvatarGroupcomponent which integrates with theCollaborationEngine.Callback for creating a stream resource with the image for a specific user.
CollaborationBinder<BEAN>Extension of
Binderfor creating collaborative forms withCollaborationEngine.CollaborationBinder.CollaborationBindingBuilderImpl<BEAN,FIELDVALUE, TARGET> Utility methods for
CollaborationBinder.CollaborationEngine is an API for creating collaborative experiences in Vaadin applications.
Configuration object for
CollaborationEngine.A
VaadinServiceInitListenerwhich applies callbacks to the service instance to reinitialize the state of topic connection context after de-serialization.A list that is shared between multiple users.
A map that is shared between multiple users.
Message of a
CollaborationMessageList.Extension of the
MessageInputcomponent which integrates with theCollaborationMessageList.Extension of the
MessageListcomponent which integrates with theCollaborationEngine.Configurator callback for messages in a
CollaborationMessageList.Persister of
CollaborationMessageitems, which enables to read and write messages from/to a backend, for example a database.A query to fetch messages from a backend.
A request to persist messages to a backend.
Submitter of messages.
The activation context of a
CollaborationMessageSubmitter.A connection context based on the attach state of a set of component instances.
The context in which a topic connection is active.
The scope of data in a topic.
Manager to handle form values and field highlight state.
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.
Functional interface that defines how to handle highlight changes for properties in a topic.
The context of the highlight.
Thrown when unable to convert back and forth between a Java object instance and a Jackson
JsonNodeinstance.Deprecated, for removal: This API element is subject to removal in a future version.license events will not be received by any listenerDeprecated, for removal: This API element is subject to removal in a future version.license events will not be received by any listenerDeprecated, for removal: This API element is subject to removal in a future version.any implementation of this interface won't receive any events, prefer using the defaultCollaborationEngineConfigurationconstructorDeprecated, for removal: This API element is subject to removal in a future version.license storage is not needed since 6.3Event that is fired when the value in a collaboration list changes.
An object which identifies each item of a
CollaborationList.A list operation providing details such as the operation type, related properties and conditions that should be met for the operation to succeed.
The result of a list operation in a
CollaborationList.Event handler that gets notified for changes to collaboration lists.
A simple backend implementation that only distributes events locally and assumes that there is no previous history for event logs.
Event that is fired when the value in a collaboration map changes.
Event handler that gets notified for changes to collaboration maps.
The event dispatched when a node joins or leaves the backend.
The type of the event.
A listener of
MembershipEvent.Functional interface that defines how to handle a message when it is added to a topic.
The context of the message.
Manager to handle messages sent to a topic.
Functional interface that defines how to handle user presence changes in a topic.
The context of the user presence.
Manager to handle user presence in topics.
Functional interface that defines how to handle value changes for properties in a topic.
The property change event.
A connection context that is always active.
A
UserInfofor non-interaction thread.API for sending and subscribing to updates between clients collaborating on the same collaboration topic.
A registration for configuring or removing a topic connection that is opened with Collaboration Engine.
An action for handling a failed topic connection.
An event that is fired when the topic connection fails.
User information of a collaborating user, used with various features of the collaboration engine.