Package com.flowingcode.vaadin.addons.chatassistant

Class ChatAssistant

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.HtmlComponent
com.vaadin.flow.component.HtmlContainer
com.vaadin.flow.component.html.Div
com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, Serializable
@NpmPackage(value="wc-chatbot", version="0.1.1") @JsModule("wc-chatbot/dist/wc-chatbot.js") @CssImport("./styles/chat-assistant-styles.css") @Tag("chat-bot") public class ChatAssistant extends com.vaadin.flow.component.html.Div
Component that allows to create a floating chat button that will open a chat window that can be used to provide a chat assistant feature.
Author:
mmlopez
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ChatAssistant.ChatSentEvent
    Event that represents a chat being sent to the component.

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

    com.vaadin.flow.component.HasText.WhiteSpace

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatAssistant()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addChatSentListener(com.vaadin.flow.component.ComponentEventListener<ChatAssistant.ChatSentEvent> listener)
    Adds a listener that will be notified when the ChatSentEvent is fired, allowing to react when a message is sent by the user or programmatically.
    void
    sendMessage(Message message)
    Sends a message to the component, by using the supplied Message object.
    void
    sendMessage(String message)
    Sends a message represented by the string message programmatically to the component, with default settings.
    void
    toggle()
    Shows or hides the chat window

    Methods inherited from class com.vaadin.flow.component.HtmlComponent

    getTitle, setTitle

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.ClickNotifier

    addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasComponents

    add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents

    getChildren, getComponentAt, getComponentCount, indexOf, replace

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasText

    getText, getWhiteSpace, setText, setWhiteSpace

  • Constructor Details

    • ChatAssistant

      public ChatAssistant()

  • Method Details

    • sendMessage

      public void sendMessage(String message)
      Sends a message represented by the string message programmatically to the component, with default settings.
      Parameters:
      message -

    • toggle

      public void toggle()
      Shows or hides the chat window

    • sendMessage

      public void sendMessage(Message message)
      Sends a message to the component, by using the supplied Message object.
      Parameters:
      message -

    • addChatSentListener

      public com.vaadin.flow.shared.Registration addChatSentListener(com.vaadin.flow.component.ComponentEventListener<ChatAssistant.ChatSentEvent> listener)
      Adds a listener that will be notified when the ChatSentEvent is fired, allowing to react when a message is sent by the user or programmatically.
      Parameters:
      listener -
      Returns:
      Registration object to allow removing the listener