v0.5.0新增一键登录同步接口

Author: raoxudong

CHANGELOG.md

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

README.md

@@ -8,7 +8,7 @@
 ```yaml
 //pub 集成
 dependencies:
-  jverify: 0.4.0
+  jverify: 0.5.0
 
 
 //github 集成  

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

@@ -91,10 +91,12 @@ public void onMethodCall(MethodCall call, Result result) {
       getToken(call,result);
     }else if (call.method.equals("verifyNumber")) {
       verifyNumber(call,result);
+    }else if (call.method.equals("preLogin")) {
+      preLogin(call, result);
     }else if (call.method.equals("loginAuth")) {
       loginAuth(call, result);
-    }else  if (call.method.equals("preLogin")) {
-      preLogin(call, result);
+    }else if (call.method.equals("loginAuthSyncApi")) {
+      loginAuthSyncApi(call, result);
     }else if (call.method.equals("dismissLoginAuthView")) {
       dismissLoginAuthView(call, result);
     }else if (call.method.equals("setCustomUI")) {
@@ -270,9 +272,18 @@ private  void  clearPreLoginCache(MethodCall call,final Result result) {
   }
 
 
-  /** SDK请求授权一键登录 */
+  /** SDK请求授权一键登录，异步 */
   private void loginAuth(MethodCall call,final Result result){
     Log.d(TAG,"Action - loginAuth:");
+    loginAuthInterface(false,call,result);
+  }
+  /** SDK请求授权一键登录，同步 */
+  private void loginAuthSyncApi(MethodCall call,final Result result) {
+    Log.d(TAG,"Action - loginAuthSyncApi:");
+    loginAuthInterface(true,call,result);
+  }
+  private void loginAuthInterface(final Boolean isSync, MethodCall call, final Result result) {
+    Log.d(TAG,"Action - loginAuthInterface:");
 
     Object autoFinish =  getValueByKey(call,"autoDismiss");
 
@@ -288,12 +299,13 @@ 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);
+        if (isSync) {
+          // 通过 channel 返回
+          channel.invokeMethod("onReceiveLoginAuthCallBackEvent",map);
+        }else {
+          // 通过回调返回
+          result.success(map);
+        }
       }
     }, new AuthPageEventListener() {
       @Override

documents/APIs.md

@@ -46,7 +46,7 @@ jverify.checkVerifyEnable().then((map){
       }else{
         // 当前网络环境不支持认证
       }
-    });
+});
 ```
 
 #### getToken
@@ -62,7 +62,7 @@ jverify.getToken().then((map){
           String _token = map["content"]; // 成功时为token，可用于调用验证手机号接口。token有效期为1分钟，超过时效需要重新获取才能使用。失败时为失败信息
           String _operator = map["operator"]; // 成功时为对应运营商，CM代表中国移动，CU代表中国联通，CT代表中国电信。失败时可能为null
           ...
-        });
+});
 ```
 
 
@@ -77,17 +77,40 @@ jverify.getToken().then((map){
 Jverify jverify = new Jverify();
 
 /// 步骤 1：调用接口设置 UI
-jverify.setCustomAuthorizationView();
+jverify.setCustomAuthorizationView(true, uiConfig, landscapeConfig: uiConfig);
 
-/// 步骤 2： 添加 loginAuth 接口回调的监听 （如果想通过 loginAuth 接口异步返回获取接口数据，则忽略此步骤）
+/// 步骤 2：调用一键登录接口
+    
+/// 方式一：使用同步接口 （如果想使用异步接口，则忽略此步骤，看方式二）
+/// 先，添加 loginAuthSyncApi 接口回调的监听 
 jverify.addLoginAuthCallBackListener((event){
-  print("通过添加监听，获取到 loginAuth 接口返回数据，code=${event.code},message = ${event.message},operator = ${event.operator}");
+  setState(() {
+    _loading = false;
+    _result = "监听获取返回数据：[${event.code}] message = ${event.message}";
+  });
+  print("通过添加监听，获取到 loginAuthSyncApi 接口返回数据，code=${event.code},message = ${event.message},operator = ${event.operator}");
 });
-/// 步骤 3：开始调用一键登录接口        
-jverify.loginAuth(true).then((map){
-  /// 步骤 4：获取 loginAuth 接口异步返回数据（如果是通过添加 JVLoginAuthCallBackListener 监听来获取返回数据，则忽略此步骤）
+/// 再，执行同步的一键登录接口
+jverify.loginAuthSyncApi(autoDismiss: true);
+
+/*   
+/// 方式二：使用异步接口 （如果想使用异步接口，则忽略此步骤，看方式一）
+    
+/// 先，执行异步的一键登录接口
+jverify.loginAuth(true).then((map) {
+
+  /// 再，在回调里获取 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";
+  });
   print("通过接口异步返回，获取到 loginAuth 接口返回数据，code=$code,message = $content,operator = $operator");
-});
+});   
+*/
+        
 ```
 
 #### setCustomAuthorizationView

example/lib/main.dart

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

example/pubspec.lock

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

ios/Classes/JverifyPlugin.m

@@ -49,7 +49,9 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
         [self verifyNumber:call result:result];
     }else if([methodName isEqualToString:@"loginAuth"]){
         [self loginAuth:call result:result];
-    }else if([methodName isEqualToString:@"preLogin"]){
+    }else if ([methodName isEqualToString:@"loginAuthSyncApi"]){
+        [self loginAuthSyncApi:call result:result];
+    } else if([methodName isEqualToString:@"preLogin"]){
         [self preLogin:call result:result];
     }else if([methodName isEqualToString:@"dismissLoginAuthView"]){
         [self dismissLoginController:call result:result];
@@ -237,8 +239,16 @@ - (void)clearPreLoginCache:(FlutterMethodCall*) call result:(FlutterResult)resul
     [JVERIFICATIONService clearPreLoginCache];
 }
 #pragma mark - SDK 请求授权一键登录
--(void)loginAuth:(FlutterMethodCall*) call result:(FlutterResult)result{
+-(void)loginAuth:(FlutterMethodCall*) call result:(FlutterResult)result {
     JVLog(@"Action - loginAuth::%@",call.arguments);
+    [self loginAuthSync:NO call:call result:result];
+}
+-(void)loginAuthSyncApi:(FlutterMethodCall*) call result:(FlutterResult)result {
+    JVLog(@"Action - loginAuthSyncApi::%@",call.arguments);
+    [self loginAuthSync:YES call:call result:result];
+}
+-(void)loginAuthSync:(BOOL)isSync call:(FlutterMethodCall*)call result:(FlutterResult)result {
+    JVLog(@"Action - loginAuthSync::%@",call.arguments);
 
     NSDictionary *arguments = [call arguments];
     NSNumber *hide = arguments[@"autoDismiss"];
@@ -263,10 +273,13 @@ -(void)loginAuth:(FlutterMethodCall*) call result:(FlutterResult)result{
                                };
         __strong typeof(weakself) strongself = weakself;
         dispatch_async(dispatch_get_main_queue(), ^{
-            //通过 channel 返回
-            [strongself.channel invokeMethod:@"onReceiveLoginAuthCallBackEvent" arguments:dict];
-            // 通过回调返回
-            result(dict);
+            if (isSync) {
+                //通过 channel 返回
+                [strongself.channel invokeMethod:@"onReceiveLoginAuthCallBackEvent" arguments:dict];
+            }else{
+                // 通过回调返回
+                result(dict);
+            }
         });
     } actionBlock:^(NSInteger type, NSString *content) {
         JVLog("Authorization actionBlock: type = %ld", (long)type);

lib/jverify.dart

@@ -182,20 +182,29 @@ class Jverify {
   }
 
   /*
-  * SDK请求授权一键登录
+  * SDK请求授权一键登录（异步接口）
   *
-  * 获取接口回调数据的两种方式：
-  *   1、可通过接口异步返回的 map 获得
-  *   2、通过添加 JVLoginAuthCallBackListener 监听，来监听接口的返回结果
+  * @return 通过接口异步返回的 map 获得
   *
-  * 授权页面点击事件监听：
-  *   通过添加 JVAuthPageEventListener 监听，来监听授权页点击事件， SDK v2.4.0 开始支持
+  * @discussion since SDK v2.4.0，授权页面点击事件监听：通过添加 JVAuthPageEventListener 监听，来监听授权页点击事件
   *
   * */
   Future<Map<dynamic, dynamic>> loginAuth(bool autoDismiss) async {
     print("$flutter_log" + "loginAuth");
-    return await _channel
-        .invokeMethod("loginAuth", {"autoDismiss": autoDismiss});
+    return await _channel.invokeMethod("loginAuth", {"autoDismiss": autoDismiss});
+  }
+
+  /*
+  * SDK请求授权一键登录（同步接口）
+  *
+  * 通过添加 JVLoginAuthCallBackListener 监听，来监听接口的返回结果
+  *
+  * @discussion since SDK v2.4.0，授权页面点击事件监听：通过添加 JVAuthPageEventListener 监听，来监听授权页点击事件
+  *
+  * */
+  void loginAuthSyncApi({@required bool autoDismiss}) {
+    print("$flutter_log" + "loginAuthSyncApi");
+    _channel.invokeMethod("loginAuthSyncApi", {"autoDismiss": autoDismiss});
   }
 
   /*

pubspec.yaml

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