Package com.vaadin.collaborationengine

Class MessageManager

java.lang.Object
com.vaadin.collaborationengine.AbstractCollaborationManager
com.vaadin.collaborationengine.MessageManager
All Implemented Interfaces:
Serializable
@Deprecated(since="25.3", forRemoval=true) public class MessageManager extends AbstractCollaborationManager
Deprecated, for removal: This API element is subject to removal in a future version.
Collaboration Kit is superseded by Vaadin Signals. Deprecated as of Vaadin 25.3 and to be removed in Vaadin 26.0. Use shared signals instead.
Manager to handle messages sent to a topic. It allows submitting messages to a topic and set a handler to react when a new message has been submitted.
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • MessageManager

      public MessageManager(Component component, UserInfo localUser, String topicId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new manager for the given component.
      Parameters:
      component - the component which holds UI access, not null
      localUser - the information of the local user, not null
      topicId - the id of the topic to connect to, not null

    • MessageManager

      public MessageManager(Component component, UserInfo localUser, String topicId, CollaborationMessagePersister persister)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new persisting manager for the given component.
      Parameters:
      component - the component which holds UI access, not null
      localUser - the information of the local user, not null
      topicId - the id of the topic to connect to, not null
      persister - the persister to read/write messages to an external source

    • MessageManager

      public MessageManager(ConnectionContext context, UserInfo localUser, String topicId, SerializableSupplier<CollaborationEngine> ceSupplier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new manager for the given connection context.
      Parameters:
      context - the context that manages connection status, not null
      localUser - the information of the local user, not null
      topicId - the id of the topic to connect to, not null
      ceSupplier - the collaboration engine instance to use, not null

    • MessageManager

      public MessageManager(ConnectionContext context, UserInfo localUser, String topicId, CollaborationMessagePersister persister, SerializableSupplier<CollaborationEngine> ceSupplier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new persisting manager for the given connection context.
      Parameters:
      context - the context that manages connection status, not null
      localUser - the information of the local user, not null
      topicId - the id of the topic to connect to, not null
      persister - the persister to read/write messages to an external source
      ceSupplier - the collaboration engine instance to use, not null

  • Method Details

    • setMessageHandler

      public void setMessageHandler(MessageHandler handler)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets a handler which will be invoked for all messages already in the topic and when a new message is submitted.

      The handler accepts a MessageHandler.MessageContext as a parameter which contains a reference to the sent message.

      Parameters:
      handler - the message handler, or null to remove an existing handler

    • submit

      public CompletableFuture<Void> submit(String text)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Submits a message to the topic as the current local user.
      Parameters:
      text - the text of the message, not null
      Returns:
      a future which will complete when the message has been added to the topic, not null

    • submit

      public CompletableFuture<Void> submit(CollaborationMessage message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Submits a message to the topic.
      Parameters:
      message - the message, not null
      Returns:
      a future which will complete when the message has been added to the topic, not null