com.vaadin.collaborationengine.CollaborationMessageSubmitter API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.collaborationengine.

All Superinterfaces:

Serializable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface CollaborationMessageSubmitter
extends Serializable
```
Submitter of messages. A submitter can be set on a CollaborationMessageList to setup the message appending logic when the connection to the associated topic is activated and also to return a callback to handle connection deactivation (e.g. disabling an input field).

Since:

3.1

Author:

Vaadin Ltd.

See Also:

CollaborationMessageList.setSubmitter(CollaborationMessageSubmitter)

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface CollaborationMessageSubmitter.ActivationContext
The activation context of a CollaborationMessageSubmitter.

Method Summary

All Methods
Modifier and Type	Method	Description
`Registration`	`onActivation(CollaborationMessageSubmitter.ActivationContext activationContext)`	Handles the activation of the submitter, for example setting up an input component to append new messages using the `CollaborationMessageSubmitter.ActivationContext.appendMessage(String)` method.

- Method Detail
  - onActivation
```
Registration onActivation(CollaborationMessageSubmitter.ActivationContext activationContext)
```
    Handles the activation of the submitter, for example setting up an input component to append new messages using the CollaborationMessageSubmitter.ActivationContext.appendMessage(String) method. The returned Registration callback can be used to handle the deactivation of the submitter, for example to disable an input component.
    
    Parameters:
    
    activationContext - the activation context
    
    Returns:
    
    the registration which will be removed when the connection is deactivated, not null