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
Class TopicConnectionRegistration
java.lang.Object
com.vaadin.collaborationengine.TopicConnectionRegistration
All Implemented Interfaces:
A registration for configuring or removing a topic connection that is opened with Collaboration Engine.
Since:
3.0
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceAn action for handling a failed topic connection.
static classAn event that is fired when the topic connection fails.
-
Method Summary
Modifier and TypeMethodDescriptionvoidonConnectionFailed(TopicConnectionRegistration.ConnectionFailedAction connectionFailedAction) Adds an action to be executed if the topic connection fails.
voidremove()Closes the topic connection.
-
Method Details
-
remove
public void remove()Closes the topic connection. NO-OP if the connection has failed.
Specified by:
removein interfaceRegistrationSee Also:
-
onConnectionFailed
public void onConnectionFailed(TopicConnectionRegistration.ConnectionFailedAction connectionFailedAction) Adds an action to be executed if the topic connection fails. The connection can fail in production mode, if your Collaboration Engine license has expired, or if the number of unique monthly end users has exceeded the quota in your license.
If the connection has already failed when calling this method, the action runs immediately.
The action is executed through
ActionDispatcher.dispatchAction(Command)of the connection context that was used to open the connection.Parameters:
connectionFailedAction- the action to handle topic connection failure, notnull
-