mix-public 1.2.0 → 1.2.2

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

@@ -0,0 +1,129 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-download-file-progress/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# getDownloadFileProgress - 获取下载进度
+
+## 功能描述
+
+获取当前文件下载进度。返回指定文件的下载进度信息。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+getDownloadFileProgress(option: Array<DownloadFilesType>, progress?: number): Array<DownloadFileProgressRecordType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | Array<DownloadFilesType> | 是 | 下载文件配置数组 | [] |
+| progress | number | 否 | 进度基准值（Web端模拟使用） | 10 |
+
+#### DownloadFilesType 接口定义
+
+```typescript
+interface DownloadFilesType {
+  downloadUrl: string;
+  path: string;
+}
+```
+
+#### DownloadFileProgressRecordType 接口定义
+
+```typescript
+interface DownloadFileProgressRecordType {
+  url: string;
+  progress?: number;
+}
+```
+
+### 返回值说明
+
+Array<DownloadFileProgressRecordType> - 返回文件下载进度数组，每个记录包含：
+- url: 下载文件名（实际为downloadUrl）
+- progress: 下载进度（0-100）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取单个文件下载进度
+const progressList = mixPublicLib.getDownloadFileProgress([
+  { downloadUrl: "https://lf9-cdn-tos.mp4", path: 'mp4/lf9-cdn-tos.mp4' }
+]);
+console.log("下载进度:", progressList);
+
+// 获取多个文件下载进度
+const multiProgress = mixPublicLib.getDownloadFileProgress([
+  { downloadUrl: "https://example.com/video1.mp4", path: 'videos/video1.mp4' },
+  { downloadUrl: "https://example.com/video2.mp4", path: 'videos/video2.mp4' }
+]);
+multiProgress.forEach(item => {
+  console.log(`文件: ${item.url}, 进度: ${item.progress}%`);
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { DownloadFilesType, DownloadFileProgressRecordType } from './paramsTypes';
+
+const downloadList: Array<DownloadFilesType> = [
+  { downloadUrl: "https://lf9-cdn-tos.mp4", path: 'mp4/lf9-cdn-tos.mp4' }
+];
+
+const progressList: Array<DownloadFileProgressRecordType> = 
+  mixPublicLib.getDownloadFileProgress(downloadList);
+
+progressList.forEach((item: DownloadFileProgressRecordType) => {
+  console.log(`文件: ${item.url}, 进度: ${item.progress}%`);
+});
+```
+
+## 使用说明
+
+### 平台差异
+
+- **APP端**: 调用原生方法获取真实的下载进度
+- **Web端**: 模拟下载进度，基于progress参数返回递增的进度值
+
+### 进度值说明
+
+- **进度范围**: 0-100，表示下载完成百分比
+- **Web端模拟**: 每次调用返回progress + 1的值（最大100）
+- **APP端**: 返回实际的下载进度
+
+### 使用场景
+
+- 实时显示文件下载进度条
+- 监控批量下载任务状态
+- 判断下载是否完成（progress >= 100）
+
+## 注意事项
+
+- 此方法在APP端返回真实进度，在Web端返回模拟进度
+- Web端的progress参数仅用于模拟，实际使用中通常不需要传入
+- 进度值为整数，范围0-100
+- 对于未开始下载的文件，可能返回undefined或0
+- 建议定期轮询获取进度，避免频繁调用影响性能
+- 下载完成后，进度值应为100
+- 已取消的下载任务可能返回异常进度值
+
+## 相关 API
+
+- [`DownloadFiles`](./038-DownloadFiles.md) - 文件下载
+- [`DownloadFileCancel`](./039-DownloadFileCancel.md) - 取消文件下载
+- [`getFinishDownloadPaths`](./043-getFinishDownloadPaths.md) - 获取本地下载列表

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

@@ -0,0 +1,103 @@
+---
+date: 2026-03-06
+permalink: /pages/api-download-file-delete/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# DownloadFileDelete - 删除已完成下载
+
+## 功能描述
+
+删除文件。用于删除已下载完成的文件。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+``typescript
+DownloadFileDelete(option: Array<string>): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | Array<string> | 是 | 文件路径数组 | [] |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```
+// 删除单个已下载文件
+mixPublicLib.DownloadFileDelete(['mp4/lf9-cdn-tos.mp4']);
+
+// 删除多个已下载文件
+mixPublicLib.DownloadFileDelete([
+  'videos/video1.mp4',
+  'videos/video2.mp4',
+  'images/image.jpg'
+]);
+```
+
+### TypeScript 示例
+
+```
+// 删除已下载文件
+const filePaths: Array<string> = ['mp4/lf9-cdn-tos.mp4'];
+mixPublicLib.DownloadFileDelete(filePaths);
+```
+
+## 使用说明
+
+### 参数说明
+
+- **option**: 要删除的文件路径数组
+- 路径必须与 `DownloadFiles` 方法中指定的path完全匹配
+- 支持同时删除多个文件
+
+### 使用场景
+
+- 用户主动清理已下载文件
+- 释放设备存储空间
+- 清理过期或不需要的下载内容
+- 应用数据管理
+
+### 平台差异
+
+- **APP端**: 调用原生文件系统删除指定文件
+- **Web端**: 控制台输出提示信息："文件下载"
+
+### 删除效果
+
+- 永久删除指定的文件
+- 释放对应的存储空间
+- 无法恢复已删除的文件
+
+## 注意事项
+
+- 此功能主要在APP环境中有效
+- Web端调用此方法不会产生实际效果
+- 只能删除已成功下载完成的文件
+- 删除操作不可逆，请谨慎使用
+- 建议在删除前确认文件不再需要
+- 路径必须准确，否则可能删除失败
+- 删除不存在的文件通常不会报错
+- 建议定期清理不需要的下载文件以节省存储空间
+
+## 相关 API
+
+- [`DownloadFiles`](./038-DownloadFiles.md) - 文件下载
+- [`getFinishDownloadPaths`](./043-getFinishDownloadPaths.md) - 获取本地下载列表
+- [`FilesPreview`](./042-FilesPreview.md) - 文件预览
+- [`ClearAppCache`](./073-ClearAppCache.md) - 清理APP缓存

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

@@ -0,0 +1,105 @@
+---
+date: 2026-03-06
+permalink: /pages/api-files-preview/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# FilesPreview - 文件预览
+
+## 功能描述
+
+预览文件。用于在APP中打开和查看已下载的文件。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+FilesPreview(option: Array<string>): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | Array<string> | 是 | 文件路径数组 | [] |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 预览单个文件
+mixPublicLib.FilesPreview(['mp4/lf9-cdn-tos.mp4']);
+
+// 预览多个文件
+mixPublicLib.FilesPreview([
+  'videos/video1.mp4',
+  'images/image.jpg',
+  'documents/file.pdf'
+]);
+```
+
+### TypeScript 示例
+
+```typescript
+// 预览文件
+const filePaths: Array<string> = ['mp4/lf9-cdn-tos.mp4'];
+mixPublicLib.FilesPreview(filePaths);
+```
+
+## 使用说明
+
+### 支持的文件类型
+
+- **视频文件**: mp4, avi, mov, mkv 等
+- **图片文件**: jpg, png, gif, bmp 等  
+- **文档文件**: pdf, doc, xls, ppt 等
+- **音频文件**: mp3, wav, flac 等
+
+### 使用场景
+
+- 查看已下载的媒体文件
+- 预览文档内容
+- 播放下载的音视频文件
+- 文件内容验证
+
+### 平台差异
+
+- **APP端**: 调用系统默认应用打开对应文件
+- **Web端**: 控制台输出提示信息："文件下载"
+
+### 预览行为
+
+- 系统会根据文件扩展名选择合适的预览应用
+- 视频和音频文件通常会直接播放
+- 图片文件会以全屏或缩略图形式显示
+- 文档文件会调用对应的阅读器应用
+
+## 注意事项
+
+- 此功能主要在APP环境中有效
+- Web端调用此方法不会产生实际效果
+- 文件必须已成功下载并存在于指定路径
+- 设备上需要安装对应文件类型的预览应用
+- 大文件预览可能需要较长时间加载
+- 某些特殊格式的文件可能无法预览
+- 建议在预览前验证文件路径的有效性
+- 预览过程中用户可以进行播放、暂停、缩放等操作
+
+## 相关 API
+
+- [`DownloadFiles`](./038-DownloadFiles.md) - 文件下载
+- [`getFinishDownloadPaths`](./043-getFinishDownloadPaths.md) - 获取本地下载列表
+- [`DownloadFileDelete`](./041-DownloadFileDelete.md) - 删除已完成下载
+- [`PhotoBrowser`](./031-PhotoBrowser.md) - 图片预览（专门用于图片）

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

@@ -0,0 +1,112 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-finish-download-paths/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# getFinishDownloadPaths - 获取本地下载列表
+
+## 功能描述
+
+获取通过DownloadFiles方法下载的文件列表。返回已完成下载的文件信息。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+getFinishDownloadPaths(): Array<FinishDownloadPathsRecordType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+#### FinishDownloadPathsRecordType 接口定义
+
+```typescript
+interface FinishDownloadPathsRecordType {
+  path: string;
+  time?: number;
+}
+```
+
+### 返回值说明
+
+Array<FinishDownloadPathsRecordType> - 返回已完成下载的文件列表，每个记录包含：
+- path: 文件路径
+- time: 下载时间（Web端为字符串格式，APP端可能为时间戳）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取所有已完成下载的文件
+const downloadList = mixPublicLib.getFinishDownloadPaths();
+console.log("已完成下载的文件:", downloadList);
+
+// 遍历文件列表
+downloadList.forEach(file => {
+  console.log(`文件路径: ${file.path}, 下载时间: ${file.time}`);
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { FinishDownloadPathsRecordType } from './paramsTypes';
+
+const downloadList: Array<FinishDownloadPathsRecordType> = 
+  mixPublicLib.getFinishDownloadPaths();
+
+downloadList.forEach((file: FinishDownloadPathsRecordType) => {
+  console.log(`文件路径: ${file.path}, 下载时间: ${file.time}`);
+});
+```
+
+## 使用说明
+
+### 数据来源
+
+- **APP端**: 从原生下载管理器获取真实的下载记录
+- **Web端**: 返回模拟的下载记录（示例数据）
+
+### 返回数据格式
+
+- **path**: 文件的本地存储路径
+- **time**: 文件下载完成的时间
+  - Web端：字符串格式（如 "2022-02-03 10:21:56"）
+  - APP端：可能为时间戳或字符串格式
+
+### 使用场景
+
+- 显示用户已下载的文件列表
+- 实现下载历史管理功能
+- 提供文件预览和删除入口
+- 统计下载使用情况
+
+## 注意事项
+
+- 此方法在APP端返回真实数据，在Web端返回模拟数据
+- Web端的示例数据固定为：`[{ path: "mp4/xgplayer-demo-720p.mp4", time: "2022-02-03 10:21:56" }]`
+- APP端的数据来源于实际的下载记录
+- 返回的文件列表只包含成功下载完成的文件
+- 已删除的文件不会出现在列表中
+- 建议定期调用此方法更新文件列表
+- 时间格式可能因平台而异，建议进行统一处理
+
+## 相关 API
+
+- [`DownloadFiles`](./038-DownloadFiles.md) - 文件下载
+- [`FilesPreview`](./042-FilesPreview.md) - 文件预览
+- [`DownloadFileDelete`](./041-DownloadFileDelete.md) - 删除已完成下载
+- [`getDownloadFileProgress`](./040-getDownloadFileProgress.md) - 获取下载进度

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

@@ -0,0 +1,141 @@
+---
+date: 2026-03-06
+permalink: /pages/api-start-http-server/
+categories: 
+  - API
+  - 网络服务
+tags: []
+author: { name: AI Assistant }
+---
+
+# StartHttpServer - 启动HTTP服务器
+
+## 功能描述
+
+启动本地HTTP服务器。用于在设备上创建本地Web服务。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+StartHttpServer(option: { 
+  port: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| port | number | 是 | 服务器端口号 | 8080 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 启动HTTP服务器（默认端口8080）
+mixPublicLib.StartHttpServer({ 
+  port: 8080 
+});
+
+// 启动HTTP服务器（自定义端口）
+mixPublicLib.StartHttpServer({ 
+  port: 3000 
+});
+
+// 在应用启动时启动本地服务器
+document.addEventListener('DOMContentLoaded', () => {
+  mixPublicLib.StartHttpServer({ port: 8080 });
+  console.log("本地HTTP服务器已启动");
+});
+
+// 处理端口冲突
+function startServerWithFallback() {
+  try {
+    mixPublicLib.StartHttpServer({ port: 8080 });
+  } catch (error) {
+    console.log("端口8080被占用，尝试端口8081");
+    mixPublicLib.StartHttpServer({ port: 8081 });
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { StartHttpServerType } from './paramsTypes';
+
+// 启动HTTP服务器
+const serverOptions: StartHttpServerType = {
+  port: 8080
+};
+mixPublicLib.StartHttpServer(serverOptions);
+```
+
+## 使用说明
+
+### 服务器特性
+
+- **本地服务**: 仅在设备本地运行，不对外网开放
+- **静态文件**: 可以提供本地文件的HTTP访问
+- **API服务**: 可以处理本地HTTP请求
+- **开发调试**: 用于开发和调试本地Web应用
+
+### 端口选择
+
+- **常用端口**: 8080, 3000, 5000, 8000等
+- **系统端口**: 1-1023需要管理员权限
+- **用户端口**: 1024-65535通常可用
+- **端口冲突**: 如果端口被占用，可能启动失败
+
+### 平台差异
+
+- **APP端**: 调用原生HTTP服务器实现
+- **Web端**: 可能不支持或提供模拟功能
+- **桌面应用**: 可能使用Node.js或其他后端技术
+
+### 使用场景
+
+- 本地文件共享
+- 开发环境的本地服务器
+- P2P文件传输的中转服务
+- 离线应用的本地API服务
+- 调试和测试Web应用
+
+## 注意事项
+
+- **权限要求**: 
+  - 需要网络权限
+  - 某些端口可能需要特殊权限
+  - 防火墙可能阻止服务器启动
+- **安全性**: 
+  - 本地服务器通常只监听127.0.0.1
+  - 避免在服务器上暴露敏感数据
+  - 考虑跨域资源共享（CORS）策略
+- **用户体验**: 
+  - 服务器启动可能需要几秒钟
+  - 提供服务器状态的反馈
+  - 处理服务器启动失败的情况
+- **最佳实践**: 
+  - 使用合适的端口号
+  - 在应用退出时停止服务器
+  - 处理端口冲突和错误情况
+  - 测试不同网络环境下的服务器行为
+- **兼容性**: 
+  - 不同平台的HTTP服务器实现可能不同
+  - 某些设备可能限制本地服务器功能
+  - 老版本系统可能不支持
+
+## 相关 API
+
+- [`StopHttpServer`](./100-StopHttpServer.md) - 停止HTTP服务器
+- [`IsNet`](./062-IsNet.md) - 检测网络状态
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息