Merge pull request #18 from raoxudong/dev

v0.4.0 一键登录回调支持添加监听接收数据

Author: raoxudong

CHANGELOG.md

@@ -1,3 +1,5 @@
+## 0.4.0
++ 新增：一键登录接口（loginAuth）返回数据支持添加监听获取 [addLoginAuthCallBackListener],具体使用查看 API 文档或者 demo 样例；
 ## 0.3.0
 + 新增：关闭授权页面接口
 ## 0.2.0

README.md

@@ -6,22 +6,14 @@
 在工程 pubspec.yaml 中加入 dependencies
 
 ```yaml
+//pub 集成
 dependencies:
-  jverify: 0.3.0
-```
-
-### 安装
+  jverify: 0.4.0
 
-在工程 pubspec.yaml 中加入 dependencies
-
-```yaml
-//pub.dev 集成
-dependencies:
-  jpush_flutter: 0.2.0
 
 //github 集成  
 dependencies:
-  jmessage_flutter:
+  jverify:
     git:
       url: git://github.com/jpush/jverify-flutter-plugin.git
       ref: master

android/src/main/java/com/jiguang/jverify/JverifyPlugin.java

@@ -288,6 +288,11 @@ public void onResult(int code, String content, String operator) {
         map.put(j_code_key,code);
         map.put(j_msg_key,content);
         map.put(j_opr_key,operator);
+
+        // 通过 channel 返回
+        channel.invokeMethod("onReceiveLoginAuthCallBackEvent",map);
+
+        // 通过回调返回
         result.success(map);
       }
     }, new AuthPageEventListener() {
@@ -981,19 +986,21 @@ private int getResourceByReflect(String imageName){
       r_id = field.getInt(field.getName());
     } catch (Exception e) {
       r_id = 0;
-      Log.e(TAG, "image【"+imageName + "】field no found!");
+      //Log.d(TAG, "image【"+imageName + "】field no found!");
     }
 
     if (r_id == 0) {
       r_id = context.getResources().getIdentifier(imageName, "drawable",context.getPackageName());
-      Log.d(TAG, "image【"+ imageName + "】 drawable found ! r_id = " + r_id);
+      //Log.d(TAG, "image【"+ imageName + "】 drawable found ! r_id = " + r_id);
     }
 
     if (r_id == 0) {
       r_id = context.getResources().getIdentifier(imageName, "mipmap",context.getPackageName());
-      Log.d(TAG, "image【"+ imageName + "】 mipmap found! r_id = " + r_id);
+      //Log.d(TAG, "image【"+ imageName + "】 mipmap found! r_id = " + r_id);
+    }
+    if (r_id == 0) {
+      Log.d(TAG, "image【"+imageName + "】field no found!");
     }
-
     return r_id;
   }
 }

documents/APIs.md

@@ -70,14 +70,24 @@ jverify.getToken().then((map){
 
 调起一键登录授权页面，在用户授权后获取loginToken
 **说明：** ios在拉起授权页面之前，必须先setCustomUI 。
+
 ```dart
+///具体使用可以查看 example 样例
+
 Jverify jverify = new Jverify();
-jverify.loginAuth().then((map){
-          int _code = map["code"]; // 返回码，6000代表loginToken获取成功，6001代表loginToken获取失败，其他返回码详见描述
-          String _token = map["content"]; // 返回码的解释信息，若获取成功，内容信息代表loginToken。
-          String _operator = map["operator"]; // 成功时为对应运营商，CM代表中国移动，CU代表中国联通，CT代表中国电信。失败时可能为null
-          ...
-        });
+
+/// 步骤 1：调用接口设置 UI
+jverify.setCustomAuthorizationView();
+
+/// 步骤 2： 添加 loginAuth 接口回调的监听 （如果想通过 loginAuth 接口异步返回获取接口数据，则忽略此步骤）
+jverify.addLoginAuthCallBackListener((event){
+  print("通过添加监听，获取到 loginAuth 接口返回数据，code=${event.code},message = ${event.message},operator = ${event.operator}");
+});
+/// 步骤 3：开始调用一键登录接口        
+jverify.loginAuth(true).then((map){
+  /// 步骤 4：获取 loginAuth 接口异步返回数据（如果是通过添加 JVLoginAuthCallBackListener 监听来获取返回数据，则忽略此步骤）
+  print("通过接口异步返回，获取到 loginAuth 接口返回数据，code=$code,message = $content,operator = $operator");
+});
 ```
 
 #### setCustomAuthorizationView

example/lib/main.dart

@@ -409,17 +409,30 @@ class _MyAppState extends State<MyApp> {
         */
 
 
-        /// 调用接口设置 UI
-         jverify.setCustomAuthorizationView(true, uiConfig, landscapeConfig: uiConfig);
+        /// 步骤 1：调用接口设置 UI
+        jverify.setCustomAuthorizationView(true, uiConfig, landscapeConfig: uiConfig);
 
-        /// 开始一键登录
+        /// 步骤 2： 添加 loginAuth 接口回调的监听 （如果想通过 loginAuth 接口异步返回获取接口数据，则忽略此步骤）
+        jverify.addLoginAuthCallBackListener((event){
+          setState(() {
+            _loading = false;
+            _result = "监听获取返回数据：[${event.code}] message = ${event.message}";
+          });
+          print("通过添加监听，获取到 loginAuth 接口返回数据，code=${event.code},message = ${event.message},operator = ${event.operator}");
+        });
+
+        /// 步骤 3：开始调用一键登录接口
         jverify.loginAuth(true).then((map) {
+
+          /// 步骤 4：获取 loginAuth 接口异步返回数据（如果是通过添加 JVLoginAuthCallBackListener 监听来获取返回数据，则忽略此步骤）
           int code = map[f_code_key];
           String content = map[f_msg_key];
+          String operator = map[f_opr_key];
           setState(() {
             _loading = false;
-            _result = "[$code] message = $content";
+            _result = "接口异步返回数据：[$code] message = $content";
           });
+          print("通过接口异步返回，获取到 loginAuth 接口返回数据，code=$code,message = $content,operator = $operator");
         });
 
       } else {

example/pubspec.lock

@@ -52,7 +52,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.3.0"
+    version: "0.4.0"
   matcher:
     dependency: transitive
     description:

ios/Classes/JverifyPlugin.m

@@ -261,7 +261,11 @@ -(void)loginAuth:(FlutterMethodCall*) call result:(FlutterResult)result{
                                j_msg_key :content,
                                j_opr_key :res[@"operator"]?:@""
                                };
+        __strong typeof(weakself) strongself = weakself;
         dispatch_async(dispatch_get_main_queue(), ^{
+            //通过 channel 返回
+            [strongself.channel invokeMethod:@"onReceiveLoginAuthCallBackEvent" arguments:dict];
+            // 通过回调返回
             result(dict);
         });
     } actionBlock:^(NSInteger type, NSString *content) {

lib/jverify.dart

@@ -11,6 +11,17 @@ import 'package:platform/platform.dart';
 typedef JVClickWidgetEventListener = void Function(String widgetId);
 /// 授权页事件回调 @since 2.4.0
 typedef JVAuthPageEventListener = void Function(JVAuthPageEvent event);
+/**
+ * 一键登录接口的回调监听
+ *
+ * @param event
+ *          code     ：返回码，6000代表loginToken获取成功，6001代表loginToken获取失败，其他返回码详见描述
+ *          message  ：返回码的解释信息，若获取成功，内容信息代表loginToken。
+ *          operator ：成功时为对应运营商，CM代表中国移动，CU代表中国联通，CT代表中国电信。失败时可能为 null
+ *
+ * @discussion 调用 loginAuth 接口后，可以通过添加此监听事件来监听接口的返回结果
+ * */
+typedef JVLoginAuthCallBackListener = void Function(JVListenerEvent event);
 
 
 
@@ -22,6 +33,7 @@ class JVEventHandlers {
 
   Map<String, JVClickWidgetEventListener> clickEventsMap = Map();
   List<JVAuthPageEventListener> authPageEvents = [];
+  List<JVLoginAuthCallBackListener> loginAuthCallBackEvents = [];
 }
 
 
@@ -54,7 +66,10 @@ class Jverify {
   addAuthPageEventListener(JVAuthPageEventListener callback) {
     _eventHanders.authPageEvents.add(callback);
   }
-
+  /// loginAuth 接口回调的监听
+  addLoginAuthCallBackListener(JVLoginAuthCallBackListener callback) {
+    _eventHanders.loginAuthCallBackEvents.add(callback);
+  }
 
   Future<void> _handlerMethod(MethodCall call) async {
     print("handleMethod method = ${call.method}");
@@ -76,6 +91,15 @@ class Jverify {
         }
       }
         break;
+      case 'onReceiveLoginAuthCallBackEvent': {
+        for (JVLoginAuthCallBackListener cb in _eventHanders.loginAuthCallBackEvents) {
+          Map json = call.arguments.cast<dynamic, dynamic>();
+          JVListenerEvent event = JVListenerEvent.fromJson(json);
+          cb(event);
+          _eventHanders.loginAuthCallBackEvents.remove(cb);
+        }
+      }
+      break;
       default:
         throw new UnsupportedError("Unrecognized Event");
     }
@@ -160,7 +184,12 @@ class Jverify {
   /*
   * SDK请求授权一键登录
   *
-  * v2.4.0 之后同时支持授权页事件监听，开发者需添加 JVAuthPageEventListener 监听
+  * 获取接口回调数据的两种方式：
+  *   1、可通过接口异步返回的 map 获得
+  *   2、通过添加 JVLoginAuthCallBackListener 监听，来监听接口的返回结果
+  *
+  * 授权页面点击事件监听：
+  *   通过添加 JVAuthPageEventListener 监听，来监听授权页点击事件， SDK v2.4.0 开始支持
   *
   * */
   Future<Map<dynamic, dynamic>> loginAuth(bool autoDismiss) async {
@@ -481,21 +510,43 @@ enum JVTextAlignmentType {
   center
 }
 
+/// 监听返回类
+class JVListenerEvent {
+  int code;//返回码，具体事件返回码请查看（https://docs.jiguang.cn/jverification/client/android_api/）
+  String message;//事件描述、事件返回值等
+  String operator;//成功时为对应运营商，CM代表中国移动，CU代表中国联通，CT代表中国电信。失败时可能为null
 
-/// 授权页事件
-class JVAuthPageEvent {
-  final int code;//返回码 // 具体事件返回码请查看（https://docs.jiguang.cn/jverification/client/android_api/）
-  final String message;//事件描述
+  JVListenerEvent.fromJson(Map<dynamic, dynamic> json)
+      : code = json['code'],
+        message = json['message'],
+        operator = json['operator'];
+
+  Map toMap() {
+    return {
+      'code': code ??= null,
+      'message': message ??= null,
+      'operator': operator ??= null
+    };
+  }
+}
 
+/// 授权页事件
+class JVAuthPageEvent extends JVListenerEvent {
+  @override
   JVAuthPageEvent.fromJson(Map<dynamic, dynamic> json)
-      : code = json['code'],
-        message = json['message'];
+      : super.fromJson(json);
 
+  @override
   Map toMap() {
-    return {'code': code, 'message': message};
+    return {
+      'code': code ??= null,
+      'message': message ??= null,
+    };
   }
 }
 
+
+
 /*
 * iOS 布局参照 item (Android 只)
 *

pubspec.yaml

@@ -1,6 +1,6 @@
 name: jverify
 description: JIGUANG Official Jverifycation SDK flutter plugin project.
-version: 0.3.0
+version: 0.4.0
 author:  shikk <[email protected]>
 homepage: https://www.jiguang.cn