@dcloudio/uni-app-x 0.7.39 → 0.7.40

package/types/uni/uts-plugin-api/lib/uni-openDocument/utssdk/interface.d.ts

@@ -6,14 +6,146 @@ export type OpenDocumentSuccess = {}
 export type OpenDocumentFail = {}
 /**
  * uni.openDocument成功回调函数定义
+ * @uniPlatform {
+ *   "mp": {
+ *     "weixin": {
+ *       "hostVer": "√",
+ *       "uniVer": "√",
+ *       "unixVer": "4.41"
+ *     },
+ *     "alipay": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "baidu": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "toutiao": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "lark": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "qq": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "kuaishou": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "jd": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     }
+ *   }
+ * }
  */
 export type OpenDocumentSuccessCallback = (res: OpenDocumentSuccess) => void
 /**
  * uni.openDocument失败回调函数定义
+ * @uniPlatform {
+ *   "mp": {
+ *     "weixin": {
+ *       "hostVer": "√",
+ *       "uniVer": "√",
+ *       "unixVer": "4.41"
+ *     },
+ *     "alipay": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "baidu": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "toutiao": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "lark": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "qq": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "kuaishou": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "jd": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     }
+ *   }
+ * }
  */
 export type OpenDocumentFailCallback = (res: OpenDocumentFail) => void
 /**
  * uni.openDocument完成回调函数定义
+ * @uniPlatform {
+ *   "mp": {
+ *     "weixin": {
+ *       "hostVer": "√",
+ *       "uniVer": "√",
+ *       "unixVer": "4.41"
+ *     },
+ *     "alipay": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "baidu": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "toutiao": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "lark": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "qq": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "kuaishou": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "jd": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     }
+ *   }
+ * }
  */
 export type OpenDocumentCompleteCallback = (res: any) => void
 
@@ -25,24 +157,295 @@ export type OpenDocumentSupportedTypes = 'doc' | 'xls' | 'ppt' | 'pdf' | 'docx'
 export type OpenDocumentOptions = {
     /**
      * 文件路径，仅支持本地路径
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     filePath: string,
     /**
      * 文件类型，指定文件类型打开文件，有效值 doc, xls, ppt, pdf, docx, xlsx, pptx
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     fileType?: OpenDocumentSupportedTypes | null,
     /**
      * 接口调用成功的回调函数
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     success?: OpenDocumentSuccessCallback | null,
     /**
      * 接口调用失败的回调函数
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     fail?: OpenDocumentFailCallback | null,
     /**
      * 接口调用结束的回调函数（调用成功、失败都会执行）
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     complete?: OpenDocumentCompleteCallback | null
+    /**
+     * 需要基础库： `2.11.0`
+     *
+     * 是否显示右上角菜单
+     *
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "2.11.0",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
+     */
+    showMenu?: boolean | null;
 }
 
 
@@ -50,61 +453,62 @@ export interface Uni {
     /**
      * 打开文档
      * @uniPlatform {
-     *    "app": {
-     *      "harmony": {
-     *        "osVer": "3.0",
-     *        "uniVer": "4.23",
-     *        "unixVer": "x"
-     *      }
-     *  },
-    *  "mp": {
-    *    "weixin": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "4.41"
-    *    },
-    *    "alipay": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "baidu": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "toutiao": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "lark": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "qq": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "kuaishou": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "jd": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    }
-    *  },
-     *  "web": {
-     *    "uniVer": "x",
-     *    "unixVer": "x"
-     *  }
+     *   "app": {
+     *     "harmony": {
+     *       "osVer": "3.0",
+     *       "uniVer": "4.23",
+     *       "unixVer": "x"
+     *     }
+     *   },
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "2.15.0",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "lark": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "qq": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "jd": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     }
+     *   },
+     *   "web": {
+     *     "uniVer": "x",
+     *     "unixVer": "x"
+     *   }
      * }
      * @uniVueVersion 2,3  //支持的vue版本
+     * @tutorial_weixin https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.openDocument.html
      */
     openDocument(options?: OpenDocumentOptions | null): void;
 }