Flutter API [Replies] (#62)

alyezz · web-flow · commit d8b89e688733 · 2019-04-16T15:16:00.000+02:00
## Mapped APIs:
* setEnabled
* show
* hasChats
* setOnNewReplyReceivedCallback
* getUnreadRepliesCount
* setInAppNotificationsEnabled
* setInAppNotificationSound
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## Master
 
+* Adds Replies Api mappings 
 * Adds Chats Api mappings
 * Adds FeatureRequests Api mappings.
 
diff --git a/README.md b/README.md
@@ -10,9 +10,9 @@ A Flutter plugin for [Instabug](https://instabug.com/).
 |:---------------------------------------------------------:|:-------:|
 | [Bug Reporting](https://instabug.com/bug-reporting)       |    ⚙️   |
 | [Crash Reporting](https://instabug.com/crash-reporting)   |    ❌   |
-| [In-App Chat](https://instabug.com/in-app-chat)           |    ❌   |
+| [In-App Chat](https://instabug.com/in-app-chat)           |    ⚙️   |
 | [In-App Surveys](https://instabug.com/in-app-surveys)     |    ⚙️   |
-| [Feature Requests](https://instabug.com/feature-requests) |    ❌   |
+| [Feature Requests](https://instabug.com/feature-requests) |    ⚙️   |
 
 * ✅ Stable
 * ⚙️ Under active development
@@ -106,6 +106,19 @@ The section below contains the APIs we're planning to implement for our 1.0 rele
 | `show()`                     | `show()`<br>`+ show`                         |
 | `setEnabled(bool isEnabled)`                  | `setState(Feature.State state)`<br>`enabled`                 |
 
+
+#### `Replies`
+
+| API Method                                    | Native Equivalent (Android/iOS)                                                                                                             |
+|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `setEnabled(bool isEnabled)`                  | `setState(Feature.State state)`<br>`enabled`                                               |
+| `show()`                                      | `show()`<br>`+ show`                                                                       |
+| `hasChats(Function function)`                 | `hasChats()`<br>`+ hasChats`                                                               |
+| `setOnNewReplyReceivedCallback(Function function)`  | `setOnNewReplyReceivedCallback(Callback callback)`<br>`didReceiveReplyHandler` 
+| `getUnreadRepliesCount(Function function)`    | `getUnreadRepliesCount()`<br>`unreadRepliesCount`                                         |
+| `setInAppNotificationsEnabled(bool isEnabled)`| `setInAppNotificationEnabled(Boolean isChatNotificationEnable)`<br>`inAppNotificationsEnabled`  |
+| `setInAppNotificationSound(bool isEnabled)`   | `setInAppNotificationSound(Boolean shouldPlaySound)`                                       |
+
 ## Integration
 
 Creating a Flutter app on the Instabug dashboard isn't possible yet. Create a React Native app instead.
diff --git a/android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java b/android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java
@@ -779,5 +779,80 @@ public void run() {
         });
     }
 
+    /**
+     * Enables and disables everything related to receiving replies.
+     * @param {boolean} isEnabled
+     */
+    public void setRepliesEnabled(final boolean isEnabled) {
+        new Handler(Looper.getMainLooper()).post(new Runnable() {
+            @Override
+            public void run() {
+                if (isEnabled) {
+                    Replies.setState(Feature.State.ENABLED);
+                } else {
+                    Replies.setState(Feature.State.DISABLED);
+                }
+            }
+        });
+    }
+
+    /**
+     * Manual invocation for replies.
+     */
+    public void showReplies() {
+        Replies.show();
+    }
+
+
+    /**
+     * Tells whether the user has chats already or not.
+     */
+    public void hasChats() {
+        boolean hasChats = Replies.hasChats();
+        channel.invokeMethod("hasChatsCallback", hasChats);
+    }
+
+    /**
+     * Sets a block of code that gets executed when a new message is received.
+     */
+    public void setOnNewReplyReceivedCallback() {
+        Runnable onNewMessageRunnable = new Runnable() {
+            @Override
+            public void run() {
+                channel.invokeMethod("onNewReplyReceivedCallback", null);
+            }
+        };
+        Replies.setOnNewReplyReceivedCallback(onNewMessageRunnable);
+    }
+
+    /**
+     * Get current unread count of messages for this user
+     *
+     * @return number of messages that are unread for this user
+     */
+    public void getUnreadRepliesCount() {
+        int unreadMessages = Replies.getUnreadRepliesCount();
+        channel.invokeMethod("unreadRepliesCountCallback", unreadMessages);
+    }
+
+    /**
+     * Enabled/disable chat notification
+     *
+     * @param isChatNotificationEnable whether chat notification is reburied or not
+     */
+    public void setChatNotificationEnabled(boolean isChatNotificationEnable) {
+            Replies.setInAppNotificationEnabled(isChatNotificationEnable);
+    }
+
+    /**
+     * Set whether new in app notification received will play a small sound notification
+     * or not (Default is {@code false})
+     *
+     * @param shouldPlaySound desired state of conversation sounds
+     * @since 4.1.0
+     */
+    public void setEnableInAppNotificationSound(boolean shouldPlaySound) {
+            Replies.setInAppNotificationSound(shouldPlaySound);
+    }
 
 }
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -9,6 +9,7 @@ import 'package:instabug_flutter/InstabugLog.dart';
 import 'package:instabug_flutter/Surveys.dart';
 import 'package:instabug_flutter/FeatureRequests.dart';
 import 'package:instabug_flutter/Chats.dart';
+import 'package:instabug_flutter/Replies.dart';
 
 void main() => runApp(MyApp());
 
@@ -36,7 +37,7 @@ class _MyAppState extends State<MyApp> {
       }
       //Instabug.showWelcomeMessageWithMode(WelcomeMessageMode.beta);
       //Instabug.setWelcomeMessageMode(WelcomeMessageMode.beta);
-      Instabug.identifyUserWithEmail('aezz@instabug.com', 'Aly Ezz');
+      Instabug.identifyUser('aezz@instabug.com', 'Aly Ezz');
       InstabugLog.logInfo('Test Log Info Message from Flutter!');
       InstabugLog.logDebug('Test Debug Message from Flutter!');
       InstabugLog.logVerbose('Test Verbose Message from Flutter!');
@@ -47,14 +48,14 @@ class _MyAppState extends State<MyApp> {
       //Instabug.setLocale(Locale.German);
       Instabug.setColorTheme(ColorTheme.dark);
       Instabug.appendTags(<String>['tag1', 'tag2']);
-      Instabug.setUserAttributeWithKey('19', 'Age');
-      Instabug.setUserAttributeWithKey('female', 'gender');
-      Instabug.removeUserAttributeForKey('gender');
+      Instabug.setUserAttribute('19', 'Age');
+      Instabug.setUserAttribute('female', 'gender');
+      Instabug.removeUserAttribute('gender');
       final String value = await Instabug.getUserAttributeForKey('Age');
       print('User Attribute ' + value);
       final Map<String, String> userAttributes = await Instabug.getUserAttributes();
       print(userAttributes.toString()); 
-      Instabug.logUserEventWithName('Aly Event');
+      Instabug.logUserEvent('Aly Event');
       Instabug.setValueForStringWithKey('What\'s the problem', IBGCustomTextPlaceHolderKey.reportBug);
       Instabug.setValueForStringWithKey('Send some ideas', IBGCustomTextPlaceHolderKey.reportFeedback);
       Instabug.setSessionProfilerEnabled(false);
@@ -73,6 +74,10 @@ class _MyAppState extends State<MyApp> {
       Surveys.setAutoShowingEnabled(false);
       Surveys.setOnShowCallback(surveyShown);
       Surveys.setOnDismissCallback(surveyDismiss);
+      //Replies.setInAppNotificationsEnabled(false);
+      Replies.setEnabled(true);
+      Replies.show();
+      Replies.setOnNewReplyReceivedCallback(replies);
       //BugReporting.setEnabledAttachmentTypes(false, false, false, false);
       //BugReporting.setReportTypes(<ReportType>[ReportType.FEEDBACK,ReportType.BUG]);
       //BugReporting.setExtendedBugReportMode(ExtendedBugReportMode.ENABLED_WITH_REQUIRED_FIELDS);
@@ -120,6 +125,10 @@ class _MyAppState extends State<MyApp> {
    void hasResponded(bool hasResponded) {
     debugPrint(hasResponded.toString());
   }
+
+  void replies() {
+    debugPrint("new Replyyy");
+  }
   void show() {
     //Instabug.show();
     // Surveys.getAvailableSurveys(getSurveys);
@@ -129,9 +138,10 @@ class _MyAppState extends State<MyApp> {
     //BugReporting.showWithOptions(ReportType.bug, <InvocationOption>[InvocationOption.emailFieldHidden]);
     // FeatureRequests.setEmailFieldRequired(false, [ActionType.allActions]);
     // FeatureRequests.show();
-    Chats.setEnabled(true);
-    Chats.show();
-    
+    // Replies.setEnabled(true);
+    // Replies.show();
+    //Replies.setInAppNotificationsEnabled(false);
+    //Replies.getUnreadRepliesCount(replies);
   }
 
   void invokeWithMode() {
diff --git a/ios/Classes/InstabugFlutterPlugin.m b/ios/Classes/InstabugFlutterPlugin.m
@@ -654,6 +654,59 @@ + (void)setChatsEnabled:(NSNumber *)isEnabled {
    IBGChats.enabled = boolValue;
 }
 
+/**
+  * Enables and disables everything related to receiving replies.
+  * @param {boolean} isEnabled 
+  */
++ (void)setRepliesEnabled:(NSNumber *)isEnabled {
+   BOOL boolValue = [isEnabled boolValue];
+   IBGReplies.enabled = boolValue;
+}
+
+/**
+  * Manual invocation for replies.
+  */
++ (void)showReplies {
+   [IBGReplies show];
+}
+
+/**
+  * Tells whether the user has chats already or not.
+  */
++ (void)hasChats {
+    BOOL hasChats = IBGReplies.hasChats;
+    NSNumber *boolNumber = [NSNumber numberWithBool:hasChats];
+    [channel invokeMethod:@"hasChatsCallback" arguments:boolNumber];
+}
+
+/**
+  * Sets a block of code that gets executed when a new message is received.
+  */
++ (void)setOnNewReplyReceivedCallback {
+  IBGReplies.didReceiveReplyHandler = ^{
+          [channel invokeMethod:@"onNewReplyReceivedCallback" arguments:nil];
+        };
+}
+
+/**
+  * Get current unread count of messages for this user
+  *
+  * @return number of messages that are unread for this user
+  */
++ (void)getUnreadRepliesCount {
+    [channel invokeMethod:@"unreadRepliesCountCallback" arguments:@(IBGReplies.unreadRepliesCount)];
+}
+
+/**
+  * Enabled/disable chat notification
+  *
+  * @param isEnabled whether chat notification is reburied or not
+  */
++ (void)setChatNotificationEnabled:(NSNumber *)isEnabled {
+   BOOL boolValue = [isEnabled boolValue];
+   IBGReplies.inAppNotificationsEnabled = boolValue;
+}
+
 
 + (NSDictionary *)constants {
   return @{
diff --git a/lib/BugReporting.dart b/lib/BugReporting.dart
@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/Instabug.dart';
 
@@ -30,8 +29,8 @@ enum ExtendedBugReportMode {
 
 class BugReporting {
 
-  static Function onInvokeCallback;
-  static Function onDismissCallback;
+  static Function _onInvokeCallback;
+  static Function _onDismissCallback;
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
   static Future<String> get platformVersion async {
@@ -42,10 +41,10 @@ class BugReporting {
   static Future<dynamic> _handleMethod(MethodCall call) async {
   switch(call.method) {
     case 'onInvokeCallback':
-      onInvokeCallback();
+      _onInvokeCallback();
       return ;
     case 'onDismissCallback':
-      Map<dynamic, dynamic> map = call.arguments;
+      final Map<dynamic, dynamic> map = call.arguments;
       DismissType dismissType;
       ReportType reportType;
       final String dismissTypeString = map['dismissType'].toUpperCase();
@@ -73,19 +72,19 @@ class BugReporting {
           break;
       }
       try {
-        onDismissCallback(dismissType,reportType);
+        _onDismissCallback(dismissType,reportType);
       }
       catch(exception) {
-        onDismissCallback();
+        _onDismissCallback();
       }
       return ;
   }
 }
   /// invoke sdk manually with desire invocation mode
   /// [invocationMode] the invocation mode
   /// [invocationOptions] the array of invocation options
-  static void invokeWithMode(InvocationMode invocationMode, [List<InvocationOption> invocationOptions]) async {
-    List<String> invocationOptionsStrings = <String>[];
+  static void invoke(InvocationMode invocationMode, [List<InvocationOption> invocationOptions]) async {
+    final List<String> invocationOptionsStrings = <String>[];
     if (invocationOptions != null) {
       invocationOptions.forEach((e) {
         invocationOptionsStrings.add(e.toString());
@@ -108,7 +107,7 @@ class BugReporting {
    /// [function]  A callback that gets executed before invoking the SDK
   static void setOnInvokeCallback(Function function) async {
      _channel.setMethodCallHandler(_handleMethod);
-    onInvokeCallback = function;
+    _onInvokeCallback = function;
     await _channel.invokeMethod<Object>('setOnInvokeCallback'); 
   } 
   
@@ -118,15 +117,15 @@ class BugReporting {
    /// [function]  A callback that gets executed before invoking the SDK
   static void setOnDismissCallback(Function function) async {
      _channel.setMethodCallHandler(_handleMethod);
-    onDismissCallback = function;
+    _onDismissCallback = function;
     await _channel.invokeMethod<Object>('setOnDismissCallback'); 
   } 
 
    /// Sets the events that invoke the feedback form.
    /// Default is set by `Instabug.startWithToken`.
    /// [invocationEvents] invocationEvent List of events that invokes the
   static void setInvocationEvents(List<InvocationEvent> invocationEvents) async {
-    List<String> invocationEventsStrings = <String>[];
+    final List<String> invocationEventsStrings = <String>[];
     if (invocationEvents != null) {
       invocationEvents.forEach((e) {
         invocationEventsStrings.add(e.toString());
@@ -151,7 +150,7 @@ class BugReporting {
    ///Sets what type of reports, bug or feedback, should be invoked.
    /// [reportTypes] - List of reportTypes
   static void setReportTypes(List<ReportType> reportTypes) async {
-    List<String> reportTypesStrings = <String>[];
+    final List<String> reportTypesStrings = <String>[];
     if (reportTypes != null) {
       reportTypes.forEach((e) {
         reportTypesStrings.add(e.toString());
@@ -173,7 +172,7 @@ class BugReporting {
    /// Default is set by `Instabug.startWithToken`.
    /// [invocationOptions] List of invocation options
   static void setInvocationOptions(List<InvocationOption> invocationOptions) async {
-    List<String> invocationOptionsStrings = <String>[];
+    final List<String> invocationOptionsStrings = <String>[];
     if (invocationOptions != null) {
       invocationOptions.forEach((e) {
         invocationOptionsStrings.add(e.toString());
@@ -186,8 +185,8 @@ class BugReporting {
    /// Invoke bug reporting with report type and options.
    /// [reportType] type 
    /// [invocationOptions]  List of invocation options
-  static void showWithOptions(ReportType reportType, List<InvocationOption> invocationOptions) async {
-    List<String> invocationOptionsStrings = <String>[];
+  static void show(ReportType reportType, List<InvocationOption> invocationOptions) async {
+    final List<String> invocationOptionsStrings = <String>[];
     if (invocationOptions != null) {
       invocationOptions.forEach((e) {
         invocationOptionsStrings.add(e.toString());
diff --git a/lib/Chats.dart b/lib/Chats.dart
@@ -1,7 +1,5 @@
 import 'dart:async';
-import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/Instabug.dart';
 
 
 class Chats {
diff --git a/lib/FeatureRequests.dart b/lib/FeatureRequests.dart
@@ -1,7 +1,5 @@
 import 'dart:async';
-import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/Instabug.dart';
 
 enum ActionType {
   allActions,
@@ -30,7 +28,7 @@ class FeatureRequests {
   /// field is required or not.
   /// [actionTypes] An enum that indicates which action types will have the isEmailFieldRequired
   static void setEmailFieldRequired(bool isEmailFieldRequired, List<ActionType> actionTypes) async {
-    List<String> actionTypesStrings = <String>[];
+    final List<String> actionTypesStrings = <String>[];
     if (actionTypes != null) {
       actionTypes.forEach((e) {
         actionTypesStrings.add(e.toString());
diff --git a/lib/Instabug.dart b/lib/Instabug.dart
diff --git a/lib/Replies.dart b/lib/Replies.dart
diff --git a/lib/Surveys.dart b/lib/Surveys.dart
diff --git a/test/instabug_flutter_test.dart b/test/instabug_flutter_test.dart
