[Mob 3192] - Flutter API: welcomeMessageMode (#56)

Android API Mapping
iOS API Mapping
Flutter API Mapping
Adds tests for new API
updates Readme
updated Changelog

Author: alyezz

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Master
 
+* Adds setWelcomeMessageMode API mapping.
 * Adds addFileAttachmentWithURL, addFileAttachmentWithData, clearFileAttachments API mapping.
 * Adds setUserData API mapping.
 * Adds setPrimaryColor API mapping.

README.md

@@ -42,14 +42,14 @@ The section below contains the APIs we're planning to implement for our 1.0 rele
 | `getUserAttributes()`                                                | `getAllUserAttributes()`<br>`+ userAttributes:`                                                           |
 | `logUserEventWithName(String name)`                                  | `logUserEvent(String name)`<br>`+ logUserEventWithName:`                                                  |
 | `show()`                                                             | `show()`<br>`+ show`                                                                                      |
-| `setSessionProfilerEnabled(bool sessionProfilerEnabled)`            | `setSessionProfilerState(Feature.State state)`<br>`sessionProfilerEnabled`                                |
-|`setPrimaryColor(Color color)`                                       | `setPrimaryColor(@ColorInt int primaryColorValue)`<br>`tintColor`                                         |
+| `setSessionProfilerEnabled(bool sessionProfilerEnabled)`             | `setSessionProfilerState(Feature.State state)`<br>`sessionProfilerEnabled`                                |
+| `setPrimaryColor(Color color)`                                       | `setPrimaryColor(@ColorInt int primaryColorValue)`<br>`tintColor`                                         |
 |                                                                      | `onReportSubmitHandler(Report.OnReportCreatedListener listener)`<br>`willSendReportHandler`.              |
-|`setUserData(String userData)`                                        | `setUserData(String userData)`<br>`userData`                                                              |
+| `setUserData(String userData)`                                       | `setUserData(String userData)`<br>`userData`                                                              |
 | `addFileAttachmentWithURL(String filePath, String fileName)`         | `addFileAttachment(Uri fileUri, String fileNameWithExtension)`<br>`+ addFileAttachmentWithURL:`           |
 | `addFileAttachmentWithData(Uint8List data, String fileName)`         | `addFileAttachment(byte[] data, String fileNameWithExtension)` `+ addFileAttachmentWithData:`             |
 | `clearFileAttachments()`                                             | `clearFileAttachment()`<br>`+ clearFileAttachments`                                                       |
-|                                                                      | `setWelcomeMessageState(WelcomeMessage.State welcomeMessageState)`<br>`welcomeMessageMode`                |
+| `setWelcomeMessageMode(WelcomeMessageMode welcomeMessageMode)`       | `setWelcomeMessageState(WelcomeMessage.State welcomeMessageState)`<br>`welcomeMessageMode`                |
 
 #### `BugReporting`
 

android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java

@@ -459,4 +459,17 @@ public void addFileAttachmentWithData(byte[] data, String fileNameWithExtension)
     public void clearFileAttachments() {
         Instabug.clearFileAttachment();
     }
+
+    /**
+     * Sets the welcome message mode to live, beta or disabled.
+     *
+     * @param welcomeMessageMode An enum to set the welcome message mode to
+     *                          live, beta or disabled.
+     */
+    public void setWelcomeMessageMode(String welcomeMessageMode) {
+        WelcomeMessage.State resolvedWelcomeMessageMode = ArgsRegistry.getDeserializedValue(
+                welcomeMessageMode, WelcomeMessage.State.class);
+        Instabug.setWelcomeMessageState(resolvedWelcomeMessageMode);
+    }
+
 }

example/lib/main.dart

@@ -32,6 +32,7 @@ class _MyAppState extends State<MyApp> {
         Instabug.start('9582e6cfe34e2b8897f48cfa3b617adb', <InvocationEvent>[InvocationEvent.floatingButton, InvocationEvent.shake]);
       }
       Instabug.showWelcomeMessageWithMode(WelcomeMessageMode.beta);
+      Instabug.setWelcomeMessageMode(WelcomeMessageMode.beta);
       Instabug.identifyUserWithEmail('[email protected]', 'Aly Ezz');
       InstabugLog.logInfo('Test Log Info Message from Flutter!');
       InstabugLog.logDebug('Test Debug Message from Flutter!');

ios/Classes/InstabugFlutterPlugin.m

@@ -347,6 +347,17 @@ + (void)clearFileAttachments {
   [Instabug clearFileAttachments];
 }
 
+/**
+  * Sets the welcome message mode to live, beta or disabled.
+  *
+  * @param welcomeMessageMode An enum to set the welcome message mode to
+  *                          live, beta or disabled.
+  */
++ (void)setWelcomeMessageMode:(NSString *)welcomeMessageMode {
+    NSDictionary *constants = [self constants];
+    NSInteger welcomeMode = ((NSNumber *) constants[welcomeMessageMode]).integerValue;
+    [Instabug setWelcomeMessageMode:welcomeMode];
+}
 
 + (NSDictionary *)constants {
   return @{

lib/Instabug.dart

@@ -261,6 +261,13 @@ class Instabug {
       await _channel.invokeMethod<Object>('clearFileAttachments'); 
   } 
 
+  ///Sets the welcome message mode to live, beta or disabled.
+  ///[welcomeMessageMode] An enum to set the welcome message mode to live, beta or disabled.
+  static void setWelcomeMessageMode(WelcomeMessageMode welcomeMessageMode) async {
+    final List<dynamic> params = <dynamic>[welcomeMessageMode.toString()];
+    await _channel.invokeMethod<Object>('setWelcomeMessageMode:', params); 
+  } 
+
 }
 
 

test/instabug_flutter_test.dart

@@ -351,6 +351,16 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  test('setWelcomeMessageMode Test', () async {
+    final List<dynamic> args = <dynamic>[WelcomeMessageMode.live.toString()];
+    Instabug.setWelcomeMessageMode(WelcomeMessageMode.live);
+    expect(log, <Matcher>[
+      isMethodCall('setWelcomeMessageMode:',
+        arguments: args,
+      )
+    ]);
+  });
+
 }