@gov-api-package/subscribe-manager - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

package.json

 {
   "name": "@gov-api-package/subscribe-manager",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "订阅和订阅状态查询",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -48,4 +48,4 @@ # 订阅API
 | ---- | ---- | ---- | ---- |
-| sourceFlag | string | 订阅标识 | 是 |
-| openId | string | 小程序openId | 是 |
+| sourceFlag | String | 订阅标识 | 是 |
+| openId | String | 小程序openId | 是 |
 
@@ -59,3 +59,9 @@ #### API返回参数：
     "sub_title":"官方小程序",
-    "button_color":"#D23B3A"
+    "intervene_type": 1,
+    "intervene": [
+        {
+            "type": 1,
+            "vaule": "110100"
+        }
+    ]
 }
@@ -70,5 +76,3 @@ ```
 */
-getSubInfo(cardFlag, openId) {
-    subscribeManager.querySub(cardFlag, openId).then(
-    res => {
+subscribeManager.querySub(cardFlag, openId).then(res => {
     console.log(res);
@@ -78,4 +82,3 @@ // 业务逻辑...
     console.log(err);
-    });
-}
+});
 ```
@@ -87,8 +90,10 @@
 | ---- | ---- | ---- | ---- | ---- |
-| subscribeID | string | 订阅id | 是 | |
-| openId | string | 小程序openId | 是 | |
-| sourceFlag | string | 来源标识 | 否 | |
+| subscribeID | String | 订阅id | 是 | |
+| openId | String | 小程序openId | 是 | |
+| sourceFlag | String | 来源标识 | 否 | |
 | interveneProps | Object | 特征类型和列表 | 否 | 仅在有特征数据时需要传入该数据 |
-| >>interveneProps.interveneType | number | 特征类型 | 否 | 1（城市），2（省份），3（快递公司），4（运动员）...<br>（仅在特征类型为1【城市】或者2【省份】且需要【代获取当前位置的特征列表】时，需要传入） |
+| >>interveneProps.interveneType | Number | 特征类型 | 否 | 1（城市）<br>2（省份）<br>3（快递公司）<br>4（运动员）...<br>（仅在特征类型为1【城市】或者2【省份】且需要【代获取当前位置的特征列表】时，需要传入） |
 | >>interveneProps.intervene | Array | 修改特征列表 | 否 | 当特征类型为非1【城市】且非2【省份】时，特征列表必须传入 |
+| >> >> interveneProps.intervene[].type | Number | 特征类型<br>1（城市）<br>2（省份）<br>3（快递公司）<br>4（运动员） | 是 | |
+|>> >> interveneProps.intervene[].value | String | 用英文逗号把vaule值连接起来 | 是 | |
 
@@ -114,27 +119,41 @@ #### API返回参数：
 /**
-* 订阅
-*/
-onSubscribe() {
-    subscribeManager.addSub(subscribeID, openId, cardFlag).then(res => {
-        console.log(res);
-        // res.code 为 0 时接口正常
-        // 业务逻辑...
-        if(!res.code) {
-            swan.showToast({
-                title:'订阅成功',
-                icon:'none'
-            });
-        }else{
-            swan.showToast({
-                title:'订阅失败',
-                icon:'none'
-            });
+ * 订阅
+ * @param {string} subscribeID 订阅id
+ * @param {string} openId 小程序openId
+ * @param {string} sourceFlag 来源标识
+ * @param {Object} interveneProps 特征类型和列表
+ * @return {Promise} 请求对象
+ */
+subscribeManager.addSub(subscribeID, openId, sourceFlag){
+    intervene: [
+        {
+            "type": 1, // type 1是城市
+            "value": "130000,130001,130002"
+        },
+        {
+            "type": 2, // type 2是省份
+            "value": "130000,130003"
         }
-        }).catch(err => {
-            swan.showToast({
+    ]
+}).then(res => {
+    console.log(res);
+    // res.code 为 0 时接口正常
+    // 业务逻辑...
+    if(!res.code) {
+        swan.showToast({
+            title:'订阅成功',
+            icon:'none'
+        });
+    }else{
+        swan.showToast({
             title:'订阅失败',
             icon:'none'
         });
+    }
+}).catch(err => {
+    swan.showToast({
+        title:'订阅失败',
+        icon:'none'
     });
-}
+});
 ```
@@ -146,5 +165,5 @@ ### 2.2.3 取消订阅 cancelSub
 | ---- | ---- | ---- | ---- | ---- |
-| subscribeID | string | 订阅id | 是 | |
-| openId | string | 小程序openId | 是 | |
-| cardFlag | string | 来源标识 | 否 | |
+| subscribeID | String | 订阅id | 是 | |
+| openId | String | 小程序openId | 是 | |
+| sourceFlag | String | 来源标识 | 是 | |
 
@@ -171,26 +190,29 @@ #### API返回参数：
 /**
- * 取消订阅
- */
-onSubscribe() {
-    subscribeManager.cancelSub(subscribeID, openId, cardFlag).then(res => {
-        // res.code 为 0 时接口正常
-        // 业务逻辑...
-        if (!res.code) {
-            swan.showToast({
-                title: '取消成功',
-                icon: 'none'
-            });
-        } else {
-            swan.showToast({
-                title: '取消失败',
-                icon: 'none'
-            });
-        }
-    }).catch(err => {
+* 取消订阅
+*
+* @param {string} cardFlag 订阅来源
+* @param {string} openId 小程序openId
+* @param {string} sourceFlag 来源标识
+*/
+
+subscribeManager.cancelSub(subscribeID, openId, sourceFlag).then(res => {
+    // res.code 为 0 时接口正常
+    // 业务逻辑...
+    if (!res.code) {
         swan.showToast({
+            title: '取消成功',
+            icon: 'none'
+        });
+    } else {
+        swan.showToast({
             title: '取消失败',
             icon: 'none'
         });
+    }
+}).catch(err => {
+    swan.showToast({
+        title: '取消失败',
+        icon: 'none'
     });
-}
+});
 ```
@@ -208,17 +230,25 @@ ### 2.2.4 跳转订阅助手 toManage
 
-### 2.2.5 修改标签（城市等）信息 modifyIntervene
+### 2.2.5 修改干预信息 modifyIntervene
 #### API请求参数：
 | 参数 | 类型  | 说明 | 是否必填 |
 | ---- | ---- | ---- | ---- | 
-| subscribeID | string | 订阅id | 是| 
-| openId | string | 小程序openId | 是 |
-| opType | number | 1、新增标签（城市等）<br>2、取消标签（城市等）<br>3、修改标签（城市等） | 是 |
-| sourceFlag | string | 订阅标识 | 是 |
+| subscribeID | String | 订阅id | 是| 
+| openId | String | 小程序openId | 是 |
+| opType | Number | 1、新增标签（城市等）<br>2、取消标签（城市等）<br>3、修改标签（城市等） | 是 |
+| sourceFlag | String | 来源标识 | 是 |
 | intervene | Array | 修改城市列表 | 是 |
+| >> intervene[].type | Number | 特征类型 <br> 1（城市）<br>2（省份）<br>3（快递公司）<br>4（运动员）| 是 |
+| >> intervene[].value | String | 用英文逗号把vaule值连接起来 | 是 |
 #### API使用示例：
 ```javascript
 /**
- * 修改标签（城市等）信息
+ * 修改城市信息
+ * @param {string} subscribeID 订阅id
+ * @param {string} openId 小程序openId
+ * @param {number} opType 1、新增干预城市 | 2、取消干预城市 | 3、修改干预城市
+ * @param {string} sourceFlag 来源标识
+ * @param {string} intervene 修改城市列表
+ * @return {Promise} 请求对象
  */
-subscribeManager.modifyIntervene(res.id, openId, 1, cardFlag, [
+subscribeManager.modifyIntervene(subscribeID, openId, 1, sourceFlag, [
     {
@@ -225,0 +255,0 @@ "type": 1, // type 1是城市

No alert changes

Improved metrics

Total package byte prevSize

17026

increased by7.38%

Number of lines in readme file

267

increased by12.66%

No dependency changes