Package com.vaadin.flow.component.ai.ui

Interface AIMessageList

All Superinterfaces:

Serializable

public interface AIMessageList
extends Serializable

Interface for message list components that can display AI conversation messages.

Since:

25.3

Author:

Vaadin Ltd

See Also:

• AIMessage

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AIMessageList.AttachmentClickCallback	Callback for attachment click events in the message list.

Method Summary

Modifier and Type	Method	Description
void	addAttachmentClickListener(AIMessageList.AttachmentClickCallback callback)	Adds a listener that is called when an attachment in the message list is clicked.
AIMessage	addMessage(String text, String userName, List<AIAttachment> attachments)	Creates a new message with the given parameters and attachments.
default void	hideTypingIndicator(String userName)	Hides the indication that the given participant is working on a response.
default void	showTypingIndicator(String userName)	Shows an indication that the given participant is working on a response.

Method Details

addMessage

AIMessage addMessage(String text,
 String userName,
 List<AIAttachment> attachments)

Creates a new message with the given parameters and attachments. Creates a new message with the given parameters and attachments and adds it to the list.

Parameters:

text - the initial message text

userName - the name of the message sender, not null

attachments - the list of attachments to include with the message

Returns:

the created message instance, not null

showTypingIndicator

default void showTypingIndicator(String userName)

Shows an indication that the given participant is working on a response. The AIOrchestrator calls this when a turn starts, and adds the assistant message only when the first part of the response arrives, so an implementation that wants to show progress before that needs to override this method. The default implementation does nothing.

Parameters:

userName - the name of the participant, not null

hideTypingIndicator

default void hideTypingIndicator(String userName)

Hides the indication that the given participant is working on a response. The AIOrchestrator calls this before adding the assistant message, and when a turn ends without a response. The default implementation does nothing.

Parameters:

userName - the name of the participant, not null

addAttachmentClickListener

void addAttachmentClickListener(AIMessageList.AttachmentClickCallback callback)

Adds a listener that is called when an attachment in the message list is clicked.

Parameters:

callback - the callback to invoke on attachment click