Implemented messageFilter for the ChatBox and feedFilter for the ConversationList

Author: Franco Bugnano

lib/src/chatbox.dart

@@ -11,6 +11,7 @@ import './conversation.dart';
 import './chatoptions.dart';
 import './user.dart';
 import './message.dart';
+import './predicate.dart';
 
 typedef SendMessageHandler = void Function(SendMessageEvent event);
 typedef TranslationToggledHandler = void Function(TranslationToggledEvent event);
@@ -49,6 +50,7 @@ class ChatBox extends StatefulWidget {
   final String? theme;
   final TranslateConversations? translateConversations;
   final List<String> highlightedWords = const <String>[];
+  final MessagePredicate messageFilter;
 
   final Conversation? conversation;
   final bool? asGuest;
@@ -66,6 +68,7 @@ class ChatBox extends StatefulWidget {
     this.theme,
     this.translateConversations,
     //this.highlightedWords = const <String>[], // Commented out due to bug #1953
+    this.messageFilter = const MessagePredicate(),
     this.conversation,
     this.asGuest,
     this.onSendMessage,
@@ -104,6 +107,7 @@ class ChatBoxState extends State<ChatBox> {
   /// Objects stored for comparing changes
   ChatBoxOptions? _oldOptions;
   List<String> _oldHighlightedWords = [];
+  MessagePredicate _oldMessageFilter = const MessagePredicate();
   bool? _oldAsGuest;
   Conversation? _oldConversation;
 
@@ -121,7 +125,7 @@ class ChatBoxState extends State<ChatBox> {
 
       _createSession();
       _createChatBox();
-      _setHighlightedWords();
+      // messageFilter and highlightedWords are set as options for the chatbox
       _createConversation();
 
       execute('chatBox.mount(document.getElementById("talkjs-container"));');
@@ -134,9 +138,10 @@ class ChatBoxState extends State<ChatBox> {
       final chatBoxRecreated = _checkRecreateChatBox();
 
       if (chatBoxRecreated) {
-        _setHighlightedWords();
+      // messageFilter and highlightedWords are set as options for the chatbox
         _createConversation();
       } else {
+        _checkMessageFilter();
         _checkHighlightedWords();
         _checkRecreateConversation();
       }
@@ -187,6 +192,9 @@ class ChatBoxState extends State<ChatBox> {
       translateConversations: widget.translateConversations,
     );
 
+    _oldHighlightedWords = List<String>.of(widget.highlightedWords);
+    _oldMessageFilter = MessagePredicate.of(widget.messageFilter);
+
     execute('chatBox = session.createChatbox(${_oldOptions!.getJsonString(this)});');
 
     execute('chatBox.on("sendMessage", (event) => JSCSendMessage.postMessage(JSON.stringify(event)));');
@@ -259,6 +267,22 @@ class ChatBoxState extends State<ChatBox> {
     return false;
   }
 
+  void _setMessageFilter() {
+      _oldMessageFilter = MessagePredicate.of(widget.messageFilter);
+
+      execute('chatBox.setMessageFilter(${json.encode(_oldMessageFilter)});');
+  }
+
+  bool _checkMessageFilter() {
+    if (widget.messageFilter != _oldMessageFilter) {
+      _setMessageFilter();
+
+      return true;
+    }
+
+    return false;
+  }
+
   void _webViewCreatedCallback(WebViewController webViewController) async {
     if (kDebugMode) {
       print('📗 chatbox._webViewCreatedCallback');
@@ -420,6 +444,15 @@ class ChatBoxState extends State<ChatBox> {
     }
   }
 
+  /// For internal use only. Implementation detail that may change anytime.
+  ///
+  /// Sets the options for ChatBoxOptions for the properties where there exists
+  /// both a declarative option and an imperative method
+  void setExtraOptions(Map<String, dynamic> result) {
+    result['highlightedWords'] = widget.highlightedWords;
+    result['messageFilter'] = widget.messageFilter;
+  }
+
   /// For internal use only. Implementation detail that may change anytime.
   ///
   /// Evaluates the JavaScript statement given.
@@ -438,32 +471,3 @@ class ChatBoxState extends State<ChatBox> {
   }
 }
 
-/// Encapsulates the message entry field tied to the currently selected conversation.
-class MessageField {
-  /// The ChatBox associated with this message field
-  ChatBoxState chatbox;
-
-  /// The JavaScript variable name for this object.
-  String variableName;
-
-  MessageField({required this.chatbox, required this.variableName});
-
-  /// Focuses the message entry field.
-  ///
-  /// Note that on mobile devices, this will cause the on-screen keyboard to pop up, obscuring part
-  /// of the screen.
-  void focus() {
-    chatbox.execute('$variableName.focus();');
-  }
-
-  /// Sets the message field to `text`.
-  ///
-  /// Useful if you want to guide your user with message suggestions. If you want to start a UI
-  /// with a given text showing immediately, call this method before calling Inbox.mount
-  void setText(String text) {
-    chatbox.execute('$variableName.setText("$text");');
-  }
-
-  /// TODO: setVisible(visible: boolean | ConversationPredicate): void;
-}
-

lib/src/chatoptions.dart

@@ -223,6 +223,8 @@ class ChatBoxOptions {
       result['translateConversations'] = translateConversations!.getValue();
     }
 
+    chatBox.setExtraOptions(result);
+
     return json.encode(result);
   }
 

lib/src/conversation.dart

@@ -125,8 +125,8 @@ class Conversation extends _BaseConversation {
     participants = Set<Participant>.of(other.participants.map((participant) => Participant.of(participant))),
     super(
       id: other.id,
-      custom: other.custom != null ? Map<String, String?>.of(other.custom!) : null,
-      welcomeMessages: other.welcomeMessages != null ? List<String>.of(other.welcomeMessages!) : null,
+      custom: (other.custom != null ? Map<String, String?>.of(other.custom!) : null),
+      welcomeMessages: (other.welcomeMessages != null ? List<String>.of(other.welcomeMessages!) : null),
       photoUrl: other.photoUrl,
       subject: other.subject
     );
@@ -199,8 +199,8 @@ class Conversation extends _BaseConversation {
 class ConversationData extends _BaseConversation {
   ConversationData.fromJson(Map<String, dynamic> json)
     : 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,
+    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']);
 }

lib/src/conversationlist.dart

@@ -9,6 +9,7 @@ import 'package:webview_flutter/webview_flutter.dart';
 import './session.dart';
 import './conversation.dart';
 import './user.dart';
+import './predicate.dart';
 
 typedef SelectConversationHandler = void Function(SelectConversationEvent event);
 
@@ -36,16 +37,6 @@ class ConversationListOptions {
   /// NOT NEEDED FOR FLUTTER?
   //bool? useBrowserHistory;
 
-  /// Used to control which conversations are shown in the conversation feed, depending on access
-  /// level, custom conversation attributes or message read status.
-  ///
-  /// See ConversationPredicate for all available options.
-  ///
-  /// You can also modify the filter on the fly using {@link Inbox.setFeedFilter}.
-  ///
-  /// TODO: NOT YET IMPLEMENTED FOR FLUTTER
-  //ConversationPredicate? feedFilter;
-
   /// Whether to show a "Back" button at the top of the chat screen on mobile devices.
   ///
   /// NOT NEEDED FOR FLUTTER?
@@ -73,6 +64,8 @@ class ConversationListOptions {
       result['theme'] = theme;
     }
 
+    conversationList.setExtraOptions(result);
+
     return json.encode(result);
   }
 }
@@ -84,13 +77,16 @@ class ConversationList extends StatefulWidget {
 
   final String? theme;
 
+  final ConversationPredicate feedFilter;
+
   final SelectConversationHandler? onSelectConversation;
 
   const ConversationList({
     Key? key,
     required this.session,
     this.showFeedHeader,
     this.theme,
+    this.feedFilter = const ConversationPredicate(),
     this.onSelectConversation,
   }) : super(key: key);
 
@@ -113,6 +109,9 @@ class ConversationListState extends State<ConversationList> {
   /// Talk.User object.
   final _users = <String, String>{};
 
+  /// Objects stored for comparing changes
+  ConversationPredicate _oldFeedFilter = const ConversationPredicate();
+
   @override
   Widget build(BuildContext context) {
     if (kDebugMode) {
@@ -124,8 +123,15 @@ class ConversationListState extends State<ConversationList> {
 
       _createSession();
       _createConversationList();
+      // feedFilter is set as an option for the inbox
 
       execute('conversationList.mount(document.getElementById("talkjs-container"));');
+    } else {
+      // If it's not the first time that the widget is built,
+      // then check what needs to be rebuilt
+
+      // TODO: If something has changed in the Session we should do something
+      _checkFeedFilter();
     }
 
     return WebView(
@@ -163,6 +169,8 @@ class ConversationListState extends State<ConversationList> {
       theme: widget.theme,
     );
 
+    _oldFeedFilter = ConversationPredicate.of(widget.feedFilter);
+
     execute('const conversationList = session.createInbox(${options.getJsonString(this)});');
 
     execute('''conversationList.on("selectConversation", (event) => {
@@ -171,6 +179,22 @@ class ConversationListState extends State<ConversationList> {
     }); ''');
   }
 
+  void _setFeedFilter() {
+      _oldFeedFilter = ConversationPredicate.of(widget.feedFilter);
+
+      execute('conversationList.setFeedFilter(${json.encode(_oldFeedFilter)});');
+  }
+
+  bool _checkFeedFilter() {
+    if (widget.feedFilter != _oldFeedFilter) {
+      _setFeedFilter();
+
+      return true;
+    }
+
+    return false;
+  }
+
   void _webViewCreatedCallback(WebViewController webViewController) async {
     if (kDebugMode) {
       print('📗 conversationlist._webViewCreatedCallback');
@@ -246,6 +270,14 @@ class ConversationListState extends State<ConversationList> {
     return _users[user.id]!;
   }
 
+  /// For internal use only. Implementation detail that may change anytime.
+  ///
+  /// Sets the options for ConversationListOptions for the properties where there exists
+  /// both a declarative option and an imperative method
+  void setExtraOptions(Map<String, dynamic> result) {
+    result['feedFilter'] = widget.feedFilter;
+  }
+
   /// For internal use only. Implementation detail that may change anytime.
   ///
   /// Evaluates the JavaScript statement given.

lib/src/message.dart

@@ -41,11 +41,11 @@ class SentMessage {
   SentMessage.fromJson(Map<String, dynamic> json)
     : id = json['id'],
     conversationId = json['conversationId'],
-    type = json['type'] == 'UserMessage' ? MessageType.UserMessage : MessageType.SystemMessage,
+    type = (json['type'] == 'UserMessage' ? MessageType.UserMessage : MessageType.SystemMessage),
     readBy = List<String>.from(json['readBy']),
     senderId = json['senderId'],
     text = json['text'],
-    attachment = json['attachment'] != null ? Attachment.fromJson(json['attachment']) : null,
-    location = json['location'] != null ? List<double>.from(json['location']) : null;
+    attachment = (json['attachment'] != null ? Attachment.fromJson(json['attachment']) : null),
+    location = (json['location'] != null ? List<double>.from(json['location']) : null);
 }