mix-public 1.2.0 → 1.2.2

package/docs/api//346/224/257/344/273/230/345/212/237/350/203/275/101-RequestAlipay.md

@@ -0,0 +1,200 @@
+---
+date: 2026-03-06
+permalink: /pages/api-request-alipay/
+categories: 
+  - API
+  - 支付功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# RequestAlipay - 支付宝支付
+
+## 功能描述
+
+调用支付宝支付功能。用于发起支付宝支付请求并处理支付结果。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+RequestAlipay(option: RequestAlipayType): Promise<RequestAlipayResultType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | RequestAlipayType | 是 | 支付配置对象 | {} |
+
+#### RequestAlipayType 接口定义
+
+```typescript
+interface RequestAlipayType {
+  orderInfo: string;
+}
+```
+
+#### RequestAlipayResultType 接口定义
+
+```typescript
+interface RequestAlipayResultType {
+  resultStatus: string;
+  memo: string;
+  result: string;
+}
+```
+
+### 返回值说明
+
+Promise<RequestAlipayResultType> - 返回支付宝支付结果，包含以下字段：
+- resultStatus: 结果状态码（"9000": 成功，"8000": 处理中，"4000": 失败等）
+- memo: 错误描述信息
+- result: 支付结果数据（成功时包含交易信息）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 发起支付宝支付
+const orderInfo = "app_id=2021000123456789&method=alipay.trade.app.pay&..."; // 从服务器获取的订单信息
+
+mixPublicLib.RequestAlipay({ 
+  orderInfo: orderInfo 
+})
+.then(result => {
+  switch (result.resultStatus) {
+    case "9000":
+      console.log("支付成功");
+      handlePaymentSuccess(result);
+      break;
+    case "8000":
+      console.log("支付结果未知，需要查询");
+      queryPaymentStatus();
+      break;
+    case "4000":
+      console.log("支付失败:", result.memo);
+      handlePaymentFailure(result.memo);
+      break;
+    default:
+      console.log("其他支付状态:", result.resultStatus);
+  }
+})
+.catch(error => {
+  console.error("支付异常:", error);
+});
+
+// 完整的支付流程
+async function processAlipayPayment() {
+  try {
+    // 1. 从服务器获取订单信息
+    const orderData = await fetchOrderInfoFromServer();
+    
+    // 2. 发起支付宝支付
+    const paymentResult = await mixPublicLib.RequestAlipay({
+      orderInfo: orderData.orderInfo
+    });
+    
+    // 3. 处理支付结果
+    if (paymentResult.resultStatus === "9000") {
+      console.log("支付成功");
+      // 通知服务器支付完成
+      await notifyServerPaymentSuccess(paymentResult);
+    } else {
+      console.log("支付未成功:", paymentResult.memo);
+    }
+  } catch (error) {
+    console.error("支付流程错误:", error);
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { RequestAlipayType, RequestAlipayResultType } from './paramsTypes';
+
+// 支付宝支付
+const paymentOptions: RequestAlipayType = {
+  orderInfo: "app_id=2021000123456789&method=alipay.trade.app.pay&..."
+};
+
+mixPublicLib.RequestAlipay(paymentOptions)
+  .then((result: RequestAlipayResultType) => {
+    if (result.resultStatus === "9000") {
+      console.log("支付宝支付成功");
+    } else {
+      console.log(`支付状态: ${result.resultStatus}, 信息: ${result.memo}`);
+    }
+  })
+  .catch((error: any) => {
+    console.error("支付宝支付异常:", error);
+  });
+```
+
+## 使用说明
+
+### 支付流程
+
+1. 应用服务器生成支付宝订单信息（orderInfo）
+2. 客户端调用 `RequestAlipay` 发起支付
+3. 用户在支付宝中完成支付操作
+4. 支付结果通过Promise返回
+5. 应用处理支付结果并通知服务器
+
+### 结果状态码
+
+- **"9000"**: 支付成功
+- **"8000"**: 处理中（需要后续查询确认）
+- **"4000"**: 支付失败
+- **"5000"**: 重复请求
+- **"6001"**: 用户取消
+- **"6002"**: 网络错误
+
+### 平台差异
+
+- **APP端**: 调用支付宝SDK进行原生支付
+- **Web端**: 可能使用支付宝网页支付或提供模拟功能
+- **小程序**: 使用小程序的支付宝支付API
+
+### 使用场景
+
+- 商品购买支付
+- 服务费用支付
+- 订单结算
+- 在线充值
+- 数字商品购买
+
+## 注意事项
+
+- **安全性**: 
+  - orderInfo必须从可信服务器获取
+  - 不能在客户端生成支付订单信息
+  - 支付结果必须在服务器端验证
+- **用户体验**: 
+  - 用户需要安装支付宝并登录
+  - 提供其他支付方式作为备选
+  - 处理用户取消支付的情况
+- **最佳实践**: 
+  - 在服务器端完成完整的支付验证
+  - 处理各种支付状态码
+  - 提供支付超时和重试机制
+  - 测试不同网络环境下的支付效果
+- **兼容性**: 
+  - 不同平台的支付宝支付实现可能不同
+  - 某些地区可能限制支付宝支付功能
+  - 老版本支付宝可能不支持某些功能
+- **合规性**: 
+  - 遵守支付宝的开发者规范
+  - 确保应用已通过支付宝商户认证
+  - 处理退款和争议情况
+
+## 相关 API
+
+- [`RequestWechatPay`](./102-RequestWechatPay.md) - 微信支付
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示

package/docs/api//346/224/257/344/273/230/345/212/237/350/203/275/102-RequestWechatPay.md

@@ -0,0 +1,214 @@
+---
+date: 2026-03-06
+permalink: /pages/api-request-wechat-pay/
+categories: 
+  - API
+  - 支付功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# RequestWechatPay - 微信支付
+
+## 功能描述
+
+调用微信支付功能。用于发起微信支付请求并处理支付结果。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+RequestWechatPay(option: RequestWechatPayType): Promise<RequestWechatPayResultType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | RequestWechatPayType | 是 | 支付配置对象 | {} |
+
+#### RequestWechatPayType 接口定义
+
+```typescript
+interface RequestWechatPayType {
+  appId: string;
+  partnerId: string;
+  prepayId: string;
+  packageValue: string;
+  nonceStr: string;
+  timeStamp: string;
+  sign: string;
+}
+```
+
+#### RequestWechatPayResultType 接口定义
+
+```typescript
+interface RequestWechatPayResultType {
+  errCode: number;
+  errStr: string;
+}
+```
+
+### 返回值说明
+
+Promise<RequestWechatPayResultType> - 返回微信支付结果，包含以下字段：
+- errCode: 错误码（0: 成功，其他值: 失败）
+- errStr: 错误描述信息
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 发起微信支付
+const paymentParams = {
+  appId: "wx1234567890abcdef",
+  partnerId: "1234567890",
+  prepayId: "wx1234567890123456789012345678901234",
+  packageValue: "Sign=WXPay",
+  nonceStr: "5K8264ILTKCH16CQ2502SI8ZNMTM67VS",
+  timeStamp: "1609459200",
+  sign: "7FD0F2E1D8B9A7C6E5F4D3C2B1A09876"
+};
+
+mixPublicLib.RequestWechatPay(paymentParams)
+.then(result => {
+  if (result.errCode === 0) {
+    console.log("微信支付成功");
+    handlePaymentSuccess();
+  } else {
+    console.log("微信支付失败:", result.errStr);
+    handlePaymentFailure(result.errStr);
+  }
+})
+.catch(error => {
+  console.error("支付异常:", error);
+});
+
+// 完整的微信支付流程
+async function processWechatPayment() {
+  try {
+    // 1. 从服务器获取微信支付参数
+    const paymentData = await fetchWechatPaymentParamsFromServer();
+    
+    // 2. 发起微信支付
+    const paymentResult = await mixPublicLib.RequestWechatPay(paymentData);
+    
+    // 3. 处理支付结果
+    if (paymentResult.errCode === 0) {
+      console.log("支付成功");
+      // 通知服务器支付完成
+      await notifyServerPaymentSuccess();
+    } else {
+      console.log("支付失败:", paymentResult.errStr);
+    }
+  } catch (error) {
+    console.error("支付流程错误:", error);
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { RequestWechatPayType, RequestWechatPayResultType } from './paramsTypes';
+
+// 微信支付
+const paymentOptions: RequestWechatPayType = {
+  appId: "wx1234567890abcdef",
+  partnerId: "1234567890",
+  prepayId: "wx1234567890123456789012345678901234",
+  packageValue: "Sign=WXPay",
+  nonceStr: "5K8264ILTKCH16CQ2502SI8ZNMTM67VS",
+  timeStamp: "1609459200",
+  sign: "7FD0F2E1D8B9A7C6E5F4D3C2B1A09876"
+};
+
+mixPublicLib.RequestWechatPay(paymentOptions)
+  .then((result: RequestWechatPayResultType) => {
+    if (result.errCode === 0) {
+      console.log("微信支付成功");
+    } else {
+      console.log(`支付失败: ${result.errStr}`);
+    }
+  })
+  .catch((error: any) => {
+    console.error("微信支付异常:", error);
+  });
+```
+
+## 使用说明
+
+### 支付流程
+
+1. 应用服务器向微信统一下单接口获取prepay_id等参数
+2. 服务器生成签名并返回支付参数给客户端
+3. 客户端调用 `RequestWechatPay` 发起支付
+4. 用户在微信中完成支付操作
+5. 支付结果通过Promise返回
+6. 应用处理支付结果并通知服务器
+
+### 参数说明
+
+- **appId**: 微信开放平台审核通过的应用APPID
+- **partnerId**: 微信支付分配的商户号
+- **prepayId**: 预支付交易会话ID
+- **packageValue**: 固定值"Sign=WXPay"
+- **nonceStr**: 随机字符串，不长于32位
+- **timeStamp**: 时间戳，精确到秒
+- **sign**: 签名，用于验证请求合法性
+
+### 错误码说明
+
+- **0**: 支付成功
+- **-1**: 支付失败
+- **-2**: 用户取消支付
+- 其他值: 具体错误码（参考微信官方文档）
+
+### 平台差异
+
+- **APP端**: 调用微信SDK进行原生支付
+- **Web端**: 可能使用微信网页支付或提供模拟功能
+- **小程序**: 使用小程序的微信支付API
+
+### 使用场景
+
+- 商品购买支付
+- 服务费用支付
+- 订单结算
+- 在线充值
+- 数字商品购买
+
+## 注意事项
+
+- **安全性**: 
+  - 支付参数必须从可信服务器获取
+  - 不能在客户端生成支付签名
+  - 支付结果必须在服务器端验证
+- **用户体验**: 
+  - 用户需要安装微信并登录
+  - 提供其他支付方式作为备选
+  - 处理用户取消支付的情况
+- **最佳实践**: 
+  - 在服务器端完成完整的支付验证
+  - 处理各种支付状态和错误码
+  - 提供支付超时和重试机制
+  - 测试不同网络环境下的支付效果
+- **兼容性**: 
+  - 不同平台的微信支付实现可能不同
+  - 某些地区可能限制微信支付功能
+  - 老版本微信可能不支持某些功能
+- **合规性**: 
+  - 遵守微信支付的开发者规范
+  - 确保应用已通过微信支付商户认证
+  - 处理退款和争议情况
+
+## 相关 API
+
+- [`RequestAlipay`](./101-RequestAlipay.md) - 支付宝支付
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/038-DownloadFiles.md

@@ -0,0 +1,116 @@
+---
+date: 2026-03-06
+permalink: /pages/api-download-files/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# DownloadFiles - 文件下载
+
+## 功能描述
+
+下载文件。支持批量下载多个文件到指定路径。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+``typescript
+DownloadFiles(option: Array<DownloadFilesType>): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | Array<DownloadFilesType> | 是 | 下载文件配置数组 | [] |
+
+#### DownloadFilesType 接口定义
+
+``typescript
+interface DownloadFilesType {
+  downloadUrl: string;
+  path: string;
+}
+```
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```
+// 下载单个文件
+mixPublicLib.DownloadFiles([
+  { downloadUrl: "https://lf9-cdn-tos.mp4", path: 'mp4/lf9-cdn-tos.mp4' }
+]);
+
+// 批量下载多个文件
+mixPublicLib.DownloadFiles([
+  { downloadUrl: "https://example.com/video1.mp4", path: 'videos/video1.mp4' },
+  { downloadUrl: "https://example.com/video2.mp4", path: 'videos/video2.mp4' },
+  { downloadUrl: "https://example.com/image.jpg", path: 'images/image.jpg' }
+]);
+```
+
+### TypeScript 示例
+
+```
+import type { DownloadFilesType } from './paramsTypes';
+
+const downloadList: Array<DownloadFilesType> = [
+  { downloadUrl: "https://lf9-cdn-tos.mp4", path: 'mp4/lf9-cdn-tos.mp4' }
+];
+
+mixPublicLib.DownloadFiles(downloadList);
+```
+
+## 使用说明
+
+### 参数说明
+
+- **downloadUrl**: 文件的在线下载地址，必须是有效的URL
+- **path**: 文件保存的本地路径，包含目录和文件名
+
+### 路径格式
+
+- 路径可以包含目录层级，如 `videos/subfolder/video.mp4`
+- 建议使用相对路径格式
+- 文件扩展名应与实际文件类型匹配
+
+### 平台差异
+
+- **APP端**: 调用原生下载管理器进行文件下载
+- **Web端**: 控制台输出提示信息："文件下载"
+
+### 下载管理
+
+- 支持同时下载多个文件
+- 下载进度可以通过 `getDownloadFileProgress` 方法获取
+- 可以通过 `DownloadFileCancel` 方法取消下载
+
+## 注意事项
+
+- 此功能主要在APP环境中有效
+- Web端调用此方法不会产生实际效果
+- 需要用户授权存储权限（APP端）
+- downloadUrl必须可访问且有效
+- 建议对大文件进行分段下载或提供进度提示
+- 路径中的目录需要存在，否则可能下载失败
+- 下载的文件会占用设备存储空间
+- 建议定期清理不需要的下载文件
+
+## 相关 API
+
+- [`getDownloadFileProgress`](./040-getDownloadFileProgress.md) - 获取下载进度
+- [`DownloadFileCancel`](./039-DownloadFileCancel.md) - 取消文件下载
+- [`DownloadFileDelete`](./041-DownloadFileDelete.md) - 删除已完成下载
+- [`getFinishDownloadPaths`](./043-getFinishDownloadPaths.md) - 获取本地下载列表

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/039-DownloadFileCancel.md

@@ -0,0 +1,100 @@
+---
+date: 2026-03-06
+permalink: /pages/api-download-file-cancel/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# DownloadFileCancel - 取消文件下载
+
+## 功能描述
+
+取消当前文件下载。用于停止正在进行的文件下载任务。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+DownloadFileCancel(option: Array<string>): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | Array<string> | 是 | 文件路径数组 | [] |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 取消单个文件下载
+mixPublicLib.DownloadFileCancel(['https://lf9-cdn-tos.mp4']);
+
+// 取消多个文件下载
+mixPublicLib.DownloadFileCancel([
+  'https://example.com/video1.mp4',
+  'https://example.com/video2.mp4'
+]);
+```
+
+### TypeScript 示例
+
+```typescript
+// 取消文件下载
+const filePaths: Array<string> = ['https://lf9-cdn-tos.mp4'];
+mixPublicLib.DownloadFileCancel(filePaths);
+```
+
+## 使用说明
+
+### 参数说明
+
+- **option**: 要取消下载的文件URL数组
+- 每个URL必须与 `DownloadFiles` 方法中使用的downloadUrl完全匹配
+- 支持同时取消多个文件的下载
+
+### 使用场景
+
+- 用户主动取消下载
+- 网络状况不佳时停止下载
+- 应用需要释放资源时
+- 下载任务出现错误时
+
+### 平台差异
+
+- **APP端**: 调用原生下载管理器取消下载任务
+- **Web端**: 控制台输出提示信息："文件下载"
+
+### 取消效果
+
+- 停止文件下载进程
+- 释放相关网络和存储资源
+- 已下载的部分数据可能会被清理
+
+## 注意事项
+
+- 此功能主要在APP环境中有效
+- Web端调用此方法不会产生实际效果
+- 只能取消正在进行的下载任务
+- 已完成的下载无法取消
+- 取消操作可能需要一定时间生效
+- 建议在取消后检查下载状态
+- 取消的文件不会出现在已完成下载列表中
+
+## 相关 API
+
+- [`DownloadFiles`](./038-DownloadFiles.md) - 文件下载
+- [`getDownloadFileProgress`](./040-getDownloadFileProgress.md) - 获取下载进度
+- [`DownloadFileDelete`](./041-DownloadFileDelete.md) - 删除已完成下载