ChatBox class

A messaging UI for just a single conversation.

Create a Chatbox through Session.createChatbox and then call mount to show it. There is no way for the user to switch between conversations

Inheritance

Constructors

ChatBox({Key? key, required Session session, TextDirection? dir, MessageFieldOptions? messageField, bool? showChatHeader, TranslationToggle? showTranslationToggle, String? theme, ThemeOptions? themeOptions, TranslateConversations? translateConversations, List<String> highlightedWords = const <String>[], BaseMessagePredicate? messageFilter, Conversation? conversation, bool? asGuest, bool enableZoom = false, SendMessageHandler? onSendMessage, TranslationToggledHandler? onTranslationToggled, LoadingStateHandler? onLoadingStateChanged, Map<String, MessageActionHandler>? onCustomMessageAction, Map<String, ConversationActionHandler>? onCustomConversationAction, NavigationHandler? onUrlNavigation, String? scrollToMessage})
const

Properties

asGuest bool?
final
conversation Conversation?
final
dir TextDirection?
final
enableZoom bool
final
hashCode int
The hash code for this object.
no setterinherited
highlightedWords List<String>
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
messageField MessageFieldOptions?
final
messageFilter BaseMessagePredicate?
final
onCustomConversationAction Map<String, ConversationActionHandler>?
final
onCustomMessageAction Map<String, MessageActionHandler>?
final
onLoadingStateChanged LoadingStateHandler?
final
onSendMessage SendMessageHandler?
final
onTranslationToggled TranslationToggledHandler?
final
onUrlNavigation NavigationHandler?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollToMessage String?
final
session Session
final
showChatHeader bool?
final
showTranslationToggle TranslationToggle?
final
theme String?
final
themeOptions ThemeOptions?
final
translateConversations TranslateConversations?
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<ChatBox>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited