v0.6.4 新增api文档及设置获取短信方法名称修改

Author: qingqing.wang

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

@@ -116,7 +116,7 @@ public void onMethodCall(MethodCall call, Result result) {
         } else if (call.method.equals("getSMSCode")) {
             getSMSCode(call, result);
         } else if (call.method.equals("setSmsIntervalTime")) {
-            setSmsIntervalTime(call, result);
+            setGetCodeInternal(call, result);
         } else {
             result.notImplemented();
         }
@@ -193,9 +193,9 @@ private boolean isInitSuccess(MethodCall call, Result result) {
     /**
      * 设置前后两次获取验证码的时间间隔，默认 30000ms，有效范围(0,300000)
      */
-    private void setSmsIntervalTime(MethodCall call, Result result) {
+    private void setGetCodeInternal(MethodCall call, Result result) {
         Log.d(TAG, "Action - setSmsIntervalTime:");
-        Object intervalTime = getValueByKey(call, "intervalTime");
+        Object intervalTime = getValueByKey(call, "timeInterval");
         JVerificationInterface.setSmsIntervalTime((Long) intervalTime);
     }
 
@@ -227,6 +227,7 @@ public void onResult(int code, String s) {
                 Map<String, Object> map = new HashMap<>();
                 map.put(j_code_key, code);
                 map.put(j_msg_key, s);
+                map.put(j_result_key, s);
 
                 runMainThread(map, result, null);
             }

documents/APIs.md

@@ -7,7 +7,8 @@
 - [verifyNumber](#verifyNumber)
 - [loginAuth](#loginAuth)
 - [setCustomAuthViewAllWidgets](#setCustomAuthViewAllWidgets)
-
+- [setSmsIntervalTime](#setSmsIntervalTime)
+- [getSMSCode](#getSMSCode)
 #### setup
 
 添加初始化方法，调用 setup 方法初始化 Jverify SDK
@@ -363,6 +364,31 @@ widgetList.add(buttonWidget);
 
 ```
 
+#### setGetCodeInternal
+
+设置前后两次获取验证码的时间间隔，默认 30000ms，有效范围(0,300000)
+
+```dart
+Jverify jverify = new Jverify();
+jverify.setGetCodeInternal(30000);
+```
+
+#### getSMSCode
+
+获取当前在线的sim卡所在运营商及token。如果获取成功代表可以用来验证手机号。获取失败则建议做短信验证
+**说明：** 开发者可以通过SDK获取token接口的回调信息来选择验证方式，若成功获取到token则可以继续使用极光认证进行号码验证；若获取token失败，需要换用短信验证码等方式继续完成验证。
+
+
+```dart
+Jverify jverify = new Jverify();
+jverify.getSMSCode().then((map){
+          int _code = map["code"]; // 返回码，3000代表获取成功，其他为失败，详见错误码描述
+          String _uuid = map["result"]; // 成功时为uuid，
+          String _message = map["message"]; // 失败时为失败信息
+          ...
+});
+```
+
 
 |参数名	|参数类型	|说明|
 |:----:|:-----:|:-----:|
@@ -432,6 +458,10 @@ ios项目存放在 Assets.xcassets。
 |2014	|internal error while requesting token	|请求token时发生内部错误|
 |2015	|rsa encode failed	|rsa加密失败|
 |2016	|network type not supported	|当前网络环境不支持认证|
+|3001	|SDK is not initial yet	|没有初始化
+|3002	|invalided phone number	|无效电话号码
+|3003	|request frequent in Minimum Time Interval  |两次请求超过最小设置的时间间隔
+|3004	|	|请求错误,具体查看错误信息
 |4001	|parameter invalid	|参数错误。请检查参数，比如是否手机号格式不对|
 |4009	|	|解密rsa失败|
 |4018	|	|没有足够的余额|

lib/jverify.dart

@@ -183,17 +183,18 @@ class Jverify {
   }
 
   ///设置前后两次获取验证码的时间间隔，默认 30000ms，有效范围(0,300000)
-  void setSmsIntervalTime(int intervalTime) {
-    print("$flutter_log" + "setSmsIntervalTime");
-    _channel.invokeMethod("setSmsIntervalTime", {"intervalTime": intervalTime});
+  void setGetCodeInternal(int intervalTime) {
+    print("$flutter_log" + "setGetCodeInternal");
+    _channel.invokeMethod("setGetCodeInternal", {"timeInterval": intervalTime});
   }
 
 /*
    * SDK 获取短信验证码
    *
    * return Map
    *        key = "code", vlaue = 状态码，3000代表获取成功
-   *        key = "message", value = 成功即为验证码，失败为提示
+   *        key = "message", 提示信息
+   *        key = "result",uuid
    * */
   Future<Map<dynamic, dynamic>> getSMSCode(
       String phoneNum, String signId, String tempId) async {
@@ -533,19 +534,19 @@ class JVUIConfig {
   String privacyNavTitleTitle2; // 协议2 web页面导航栏标题
   String privacyNavReturnBtnImage;
 
-  ///only android
-  bool privacyStatusBarColorWithNav = false; //web状态栏是否与导航栏同色
-  bool privacyStatusBarDarkMode = false; //web状态栏是否暗色
-  bool privacyStatusBarTransparent = false; //web页状态栏是否透明
-  bool privacyStatusBarHidden = false; //web页状态栏是否隐藏
-  bool privacyVirtualButtonTransparent = false; //web页虚拟按键背景是否透明
-
-  ///导航栏only android
-  bool statusBarColorWithNav = false; //状态栏是否跟导航栏同色
-  bool statusBarDarkMode = false; //状态栏是否为暗色
-  bool statusBarTransparent = false; //状态栏是否透明
-  bool statusBarHidden = false; //状态栏是否隐藏
-  bool virtualButtonTransparent = false; //虚拟按键背景是否透明
+  ///隐私页
+  bool privacyStatusBarColorWithNav = false; //隐私页web状态栏是否与导航栏同色 only android
+  bool privacyStatusBarDarkMode = false; //隐私页web状态栏是否暗色 only android
+  bool privacyStatusBarTransparent = false; //隐私页web页状态栏是否透明 only android
+  bool privacyStatusBarHidden = false; //隐私页web页状态栏是否隐藏 only android
+  bool privacyVirtualButtonTransparent = false; //隐私页web页虚拟按键背景是否透明 only android
+
+  ///授权页
+  bool statusBarColorWithNav = false; //授权页状态栏是否跟导航栏同色 only android
+  bool statusBarDarkMode = false; //授权页状态栏是否为暗色 only android
+  bool statusBarTransparent = false; //授权页栏状态栏是否透明 only android
+  bool statusBarHidden = false; //授权页状态栏是否隐藏 only android
+  bool virtualButtonTransparent = false; //授权页虚拟按键背景是否透明 only android
 
   ///是否需要动画only android
   bool needStartAnim = false; //设置拉起授权页时是否需要显示默认动画