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
Interface HasExpirationTimeout
All Known Subinterfaces:
All Known Implementing Classes:
public interface 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.
Since:
3.1
Author:
Vaadin Ltd.
-
Method Summary
Modifier and TypeMethodDescriptionGets the optional expiration timeout of the data.
voidsetExpirationTimeout(Duration expirationTimeout) Sets the expiration timeout of the data held by the implementing object.
-
Method Details
-
getExpirationTimeout
Gets the optional expiration timeout of the data. An empty
Optionalis returned if no timeout is set, which means data is not cleared when there are no connected users to the related topic (this is the default).Returns:
the expiration timeout
-
setExpirationTimeout
Sets the expiration timeout of the data held by the implementing object. If set, data is cleared when
expirationTimeouthas passed after the last connection to the related topic is closed. If set tonull, the timeout is cancelled.Parameters:
expirationTimeout- the expiration timeout
-