ChatwootChat class FlutterClientSdk
Chatwoot chat widget
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ChatwootChat
- Annotations
Constructors
-
ChatwootChat({Key? key, required String baseUrl, required String inboxIdentifier, bool enablePersistence = true, ChatwootUser? user, PreferredSizeWidget? appBar, Future<
void> onEndReached()?, double? onEndReachedThreshold, void onMessageLongPress(BuildContext, Message)?, void onMessageTap(Message)?, void onSendPressed(PartialText)?, void onTextChanged(String)?, bool showUserAvatars = true, bool showUserNames = true, ChatwootChatTheme theme = const ChatwootChatTheme(), ChatwootL10n l10n = const ChatwootL10n(), DateFormat? timeFormat, DateFormat? dateFormat, void onWelcome()?, void onPing()?, void onConfirmedSubscription()?, void onMessageReceived(ChatwootMessage)?, void onMessageSent(ChatwootMessage)?, void onMessageDelivered(ChatwootMessage)?, void onMessageUpdated(ChatwootMessage)?, void onPersistedMessagesRetrieved(List<ChatwootMessage> )?, void onMessagesRetrieved(List<ChatwootMessage> )?, void onConversationStartedTyping()?, void onConversationStoppedTyping()?, void onConversationIsOnline()?, void onConversationIsOffline()?, void onError(ChatwootClientException)?, bool isPresentedInDialog = false}) -
const
Properties
- appBar → PreferredSizeWidget?
-
Specifies a custom app bar for chatwoot page widget
final
- baseUrl → String
-
Installation url for chatwoot
final
- dateFormat → DateFormat?
-
See
Chat.dateFormat
final - enablePersistence → bool
-
Enables persistence of chatwoot client instance's contact, conversation and messages to disk
for convenience.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inboxIdentifier → String
-
Identifier for target chatwoot inbox.
final
- isPresentedInDialog → bool
-
Horizontal padding is reduced if set to true
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- l10n → ChatwootL10n
-
See ChatwootL10n
final
- onConfirmedSubscription → void Function()?
-
See ChatwootCallbacks.onConfirmedSubscription
final
- onConversationIsOffline → void Function()?
-
See ChatwootCallbacks.onConversationIsOffline
final
- onConversationIsOnline → void Function()?
-
See ChatwootCallbacks.onConversationIsOnline
final
- onConversationStartedTyping → void Function()?
-
See ChatwootCallbacks.onConversationStartedTyping
final
- onConversationStoppedTyping → void Function()?
-
See ChatwootCallbacks.onConversationStoppedTyping
final
-
onEndReached
→ Future<
void> Function()? -
See
ChatList.onEndReached
final - onEndReachedThreshold → double?
-
See
ChatList.onEndReachedThreshold
final - onError → void Function(ChatwootClientException)?
-
See ChatwootCallbacks.onError
final
- onMessageDelivered → void Function(ChatwootMessage)?
-
See ChatwootCallbacks.onMessageDelivered
final
- onMessageLongPress → void Function(BuildContext, Message)?
-
See
Message.onMessageLongPress
final - onMessageReceived → void Function(ChatwootMessage)?
-
See ChatwootCallbacks.onMessageReceived
final
- onMessageSent → void Function(ChatwootMessage)?
-
See ChatwootCallbacks.onMessageSent
final
-
onMessagesRetrieved
→ void Function(List<
ChatwootMessage> )? -
See ChatwootCallbacks.onMessagesRetrieved
final
- onMessageTap → void Function(Message)?
-
See
Message.onMessageTap
final - onMessageUpdated → void Function(ChatwootMessage)?
-
See ChatwootCallbacks.onMessageUpdated
final
-
onPersistedMessagesRetrieved
→ void Function(List<
ChatwootMessage> )? -
See ChatwootCallbacks.onPersistedMessagesRetrieved
final
- onPing → void Function()?
-
See ChatwootCallbacks.onPing
final
- onSendPressed → void Function(PartialText)?
-
See
Input.onSendPressed
final - onTextChanged → void Function(String)?
-
See
Input.onTextChanged
final - onWelcome → void Function()?
-
See ChatwootCallbacks.onWelcome
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showUserAvatars → bool
-
Show avatars for received messages.
final
- showUserNames → bool
-
Show user names for received messages.
final
- theme → ChatwootChatTheme
-
final
- timeFormat → DateFormat?
-
See
Chat.timeFormat
final - user → ChatwootUser?
-
Custom user details to be attached to chatwoot contact
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _ChatwootChatState -
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