Started implementing ConversationList

Author: Franco Bugnano

lib/src/chatbox.dart

@@ -21,19 +21,19 @@ typedef SendMessageHandler = void Function(SendMessageEvent event);
 typedef TranslationToggledHandler = void Function(TranslationToggledEvent event);
 
 class SendMessageEvent {
-  ConversationData conversation;
-  User me;
-  SentMessage message;
+  final ConversationData conversation;
+  final UserData me;
+  final SentMessage message;
 
   SendMessageEvent.fromJson(Map<String, dynamic> json)
     : conversation = ConversationData.fromJson(json['conversation']),
-    me = User.fromJson(json['me']),
+    me = UserData.fromJson(json['me']),
     message = SentMessage.fromJson(json['message']);
 }
 
 class TranslationToggledEvent {
-  ConversationData conversation;
-  bool isEnabled;
+  final ConversationData conversation;
+  final bool isEnabled;
 
   TranslationToggledEvent.fromJson(Map<String, dynamic> json)
     : conversation = ConversationData.fromJson(json['conversation']),
@@ -92,7 +92,10 @@ class ChatBoxState extends State<ChatBox> {
   WebViewController? _webViewController;
 
   /// List of JavaScript statements that haven't been executed.
-  final List<String> _pending = [];
+  final _pending = <String>[];
+
+  // A counter to ensure that IDs are unique
+  int _idCounter = 0;
 
   /// A mapping of user ids to the variable name of the respective JavaScript
   /// Talk.User object.
@@ -102,9 +105,6 @@ class ChatBoxState extends State<ChatBox> {
   /// Talk.ConversationBuilder object.
   final _conversations = <String, String>{};
 
-  // A counter to ensure that IDs are unique
-  int _idCounter = 0;
-
   /// Encapsulates the message entry field tied to the currently selected conversation.
   // TODO: messageField still needs to be refactored
   //late MessageField messageField;
@@ -273,6 +273,7 @@ class ChatBoxState extends State<ChatBox> {
     return _users[user.id]!;
   }
 
+  /// For internal use only. Implementation detail that may change anytime.
   String getConversationVariableName(Conversation conversation) {
     if (_conversations[conversation.id] == null) {
       // STEP 1: Generate unique variable name

lib/src/chatoptions.dart

@@ -134,9 +134,8 @@ extension TranslateConversationsValue on TranslateConversations {
   }
 }
 
-/// This class represents the various configuration options used to finetune the
-/// behaviour of UI elements.
-abstract class _ChatOptions {
+/// Options to configure the behaviour of the [ChatBox] UI.
+class ChatBoxOptions {
   /// Controls what text appears in the chat subtitle, right below the chat title.
   ///
   /// Defaults to [ChatMode.subject].
@@ -181,7 +180,7 @@ abstract class _ChatOptions {
   /// This option specifies which conversation Ids should be translated in this UI.
   List<String>? conversationIdsToTranslate;
 
-  _ChatOptions({this.chatSubtitleMode,
+  ChatBoxOptions({this.chatSubtitleMode,
     this.chatTitleMode,
     this.dir,
     this.messageField,
@@ -272,29 +271,3 @@ abstract class _ChatOptions {
   }
 }
 
-/// Options to configure the behaviour of the [ChatBox] UI.
-class ChatBoxOptions extends _ChatOptions{
-  ChatBoxOptions({chatSubtitleMode,
-      chatTitleMode,
-      dir,
-      messageField,
-      showChatHeader,
-      showTranslationToggle,
-      theme,
-      translateConversations,
-      conversationsToTranslate,
-      conversationIdsToTranslate,
-      })
-      : super(chatSubtitleMode: chatSubtitleMode,
-          chatTitleMode: chatTitleMode,
-          dir: dir,
-          messageField: messageField,
-          showChatHeader: showChatHeader,
-          showTranslationToggle: showTranslationToggle,
-          theme: theme,
-          translateConversations: translateConversations,
-          conversationsToTranslate: conversationsToTranslate,
-          conversationIdsToTranslate: conversationIdsToTranslate,
-      );
-}
-

lib/src/conversation.dart

@@ -33,7 +33,7 @@ class Participant {
 /// You can use this object to set up or modify a conversation before showing it.
 /// Note: any changes you make here will not be sent to TalkJS immediately.
 /// Instead, instantiate a TalkJS UI using methods such as [Session.createInbox].
-class Conversation {
+class _BaseConversation {
   /// The unique conversation identifier.
   String id;
 
@@ -51,19 +51,27 @@ class Conversation {
   /// The conversation subject which will be displayed in the chat header.
   String? subject;
 
-  // The participants for this conversation
-  List<Participant> participants;
-
-  /// Don't use the ConversationBuilder constructor directly.
-  // use session.getOrCreateConversation instead.
-  Conversation({
+  _BaseConversation({
     required this.id,
     this.custom,
     this.welcomeMessages,
     this.photoUrl,
     this.subject,
-    this.participants = const <Participant>[],
   });
+}
+
+class Conversation extends _BaseConversation {
+  // The participants for this conversation
+  List<Participant> participants;
+
+  Conversation({
+    required String id,
+    Map<String, String?>? custom,
+    List<String>? welcomeMessages,
+    String? photoUrl,
+    String? subject,
+    this.participants = const <Participant>[],
+  }) : super(id: id, custom: custom, welcomeMessages: welcomeMessages, photoUrl: photoUrl, subject: subject);
 
 /* TODO: conversation.sendMessage is to be rewritten so that it works when we don't show the WebView
   /// Sends a text message in a given conversation.
@@ -122,31 +130,12 @@ class Conversation {
   */
 }
 
-class ConversationData {
-  /// The unique conversation identifier.
-  String id;
-
-  /// Custom metadata for this conversation
-  Map<String, String?>? custom;
-
-  /// Messages sent at the beginning of a chat.
-  ///
-  /// The messages will appear as system messages.
-  List<String>? welcomeMessages;
-
-  /// The URL to a photo which will be shown as the photo for the conversation.
-  String? photoUrl;
-
-  /// The conversation subject which will be displayed in the chat header.
-  String? subject;
-
+class ConversationData extends _BaseConversation {
   ConversationData.fromJson(Map<String, dynamic> json)
-    : id = json['id'],
-    custom = json['custom'] != null ? Map<String, String?>.from(json['custom']) : null,
-    welcomeMessages = json['welcomeMessages'] != null ? List<String>.from(json['welcomeMessages']) : null,
-    photoUrl = json['photoUrl'],
-    subject = json['subject'];
-
+    : super(id: json['id'],
+    custom: json['custom'] != null ? Map<String, String?>.from(json['custom']) : null,
+    welcomeMessages: json['welcomeMessages'] != null ? List<String>.from(json['welcomeMessages']) : null,
+    photoUrl: json['photoUrl'],
+    subject: json['subject']);
 }
 
-