[Mob 3188] - Flutter API: userData (#54)

Android API Mapping

IOS API Mapping

Flutter API Mapping

Adds tests for new API

updates Readme

updated Changelog

Changed setPrimaryColor and setSessionProfilerEnabled to use NSNumber instead of NSString

Author: alyezz

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Master
 
+* Adds setUserData API mapping.
 * Adds setPrimaryColor API mapping.
 * Adds setSessionProfilerEnabled API mapping.
 

README.md

@@ -45,7 +45,7 @@ The section below contains the APIs we're planning to implement for our 1.0 rele
 | `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)`<br>`userData`                                                              |
+|`setUserData(String userData)`                                        | `setUserData(String userData)`<br>`userData`                                                              |
 |                                                                      | `addFileAttachment(Uri fileUri, String fileNameWithExtension)`<br>`+ addFileAttachmentWithURL:`           |
 |                                                                      | `addFileAttachment(byte[] data, String fileNameWithExtension)` `+ addFileAttachmentWithData:`             |
 |                                                                      | `clearFileAttachment()`<br>`+ clearFileAttachments`                                                       |

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

@@ -414,4 +414,13 @@ public void run() {
             }
         });
     }
+
+    /**
+     * Adds specific user data that you need to be added to the reports
+     *
+     * @param userData
+     */
+    public void setUserData(String userData) {
+        Instabug.setUserData(userData);
+    }
 }

example/lib/main.dart

@@ -56,6 +56,7 @@ class _MyAppState extends State<MyApp> {
       Color c = const Color.fromRGBO(255, 0, 255, 1.0);
       Color c = const Color.fromRGBO(255, 0, 0, 1.0);
       Instabug.setPrimaryColor(c);
+      Instabug.setUserData("This is some useful data");
     } on PlatformException {
       platformVersion = 'Failed to get platform version.';
     }

ios/Classes/InstabugFlutterPlugin.m

@@ -296,7 +296,7 @@ + (void) setValue: (NSString*) value forStringWithKey: (NSString*) key {
   *
   * @param sessionProfilerEnabled desired state of the session profiler feature
   */
-+ (void) setSessionProfilerEnabled:(NSString*) sessionProfilerEnabled {
++ (void)setSessionProfilerEnabled:(NSNumber *)sessionProfilerEnabled {
    BOOL boolValue = [sessionProfilerEnabled boolValue];
    [Instabug setSessionProfilerEnabled:boolValue];
 }
@@ -306,8 +306,17 @@ + (void) setSessionProfilerEnabled:(NSString*) sessionProfilerEnabled {
   *
   * @param color The value of the primary color 
   */
-+ (void) setPrimaryColor:(NSString*) color {
-  Instabug.tintColor = UIColorFromRGB([color longLongValue]);
++ (void)setPrimaryColor:(NSNumber *)color {
+  Instabug.tintColor = UIColorFromRGB([color longValue]);
+}
+
+ /**
+  * Adds specific user data that you need to be added to the reports
+  *
+  * @param userData
+  */
++ (void)setUserData:(NSString *)userData {
+  [Instabug setUserData:userData];
 }
 
 

lib/Instabug.dart

@@ -220,6 +220,13 @@ class Instabug {
     await _channel.invokeMethod<Object>('setPrimaryColor:', params); 
   } 
 
+  /// Adds specific user data that you need to be added to the reports
+  /// [userData] data to be added
+  static void setUserData(String userData) async {
+    final List<dynamic> params = <dynamic>[userData];
+    await _channel.invokeMethod<Object>('setUserData:', params); 
+  } 
+
 }
 
 

test/instabug_flutter_test.dart

@@ -306,6 +306,17 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  test('setUserData: Test', () async {
+    String s = "This is a String";
+    final List<dynamic> args = <dynamic>[s];
+    Instabug.setUserData(s);
+    expect(log, <Matcher>[
+      isMethodCall('setUserData:',
+        arguments: args,
+      )
+    ]);
+  });
+
 }