mix-public 1.2.0 → 1.2.2

package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/093-SaveToiCloud.md

@@ -0,0 +1,143 @@
+---
+date: 2026-03-06
+permalink: /pages/api-save-to-icloud/
+categories: 
+  - API
+  - 文件管理
+tags: []
+author: { name: AI Assistant }
+---
+
+# SaveToiCloud - 保存到iCloud
+
+## 功能描述
+
+将文件保存到iCloud云存储。用于在iOS设备上将数据同步到iCloud。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SaveToiCloud(option: { 
+  fileName: string; 
+  fileData: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| fileName | string | 是 | 文件名 | "" |
+| fileData | string | 是 | 文件数据（base64格式） | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 保存文本文件到iCloud
+mixPublicLib.SaveToiCloud({ 
+  fileName: "notes.txt", 
+  fileData: btoa("这是要保存的文本内容")
+});
+
+// 保存图片到iCloud
+function saveImageToICloud(imageDataUrl, filename) {
+  // 从data URL提取base64数据
+  const base64Data = imageDataUrl.split(',')[1];
+  mixPublicLib.SaveToiCloud({
+    fileName: filename,
+    fileData: base64Data
+  });
+}
+
+// 保存用户数据到iCloud
+const userData = JSON.stringify({
+  preferences: { theme: "dark", language: "zh" },
+  settings: { notifications: true }
+});
+mixPublicLib.SaveToiCloud({
+  fileName: "user-settings.json",
+  fileData: btoa(userData)
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SaveToiCloudType } from './paramsTypes';
+
+// 保存文件到iCloud
+const iCloudOptions: SaveToiCloudType = {
+  fileName: "backup.txt",
+  fileData: btoa("备份数据内容")
+};
+mixPublicLib.SaveToiCloud(iCloudOptions);
+```
+
+## 使用说明
+
+### 文件格式支持
+
+- **文本文件**: .txt, .json, .xml, .csv 等
+- **图片文件**: .jpg, .png, .gif 等（需要base64编码）
+- **其他文件**: 任何可以转换为base64的数据
+
+### 数据格式要求
+
+- **fileData**: 必须是base64编码的字符串
+- **fileName**: 包含文件扩展名的完整文件名
+- **文件大小**: 受iCloud存储空间限制
+
+### 平台差异
+
+- **iOS**: 完全支持iCloud文件保存功能
+- **Android**: 可能不支持或提供模拟功能
+- **Web端**: 通常不支持iCloud功能
+
+### 使用场景
+
+- 用户数据的云备份
+- 跨设备数据同步
+- 重要文件的安全存储
+- 应用配置的云端保存
+- 文档和笔记的自动同步
+
+## 注意事项
+
+- **平台限制**: 
+  - 此功能主要针对iOS平台
+  - Android和Web端可能不支持
+  - 需要用户登录Apple ID并启用iCloud
+- **权限要求**: 
+  - iOS需要用户授权iCloud访问权限
+  - 需要在Info.plist中配置iCloud相关权限
+  - 某些iCloud容器可能需要特殊配置
+- **用户体验**: 
+  - 保存过程可能需要几秒钟
+  - 大文件保存可能消耗较多时间和存储空间
+  - 建议提供保存进度提示
+- **最佳实践**: 
+  - 在保存前验证文件数据的有效性
+  - 提供保存成功的确认提示
+  - 处理iCloud存储空间不足的情况
+  - 测试不同文件类型和大小的保存效果
+- **兼容性**: 
+  - 不同iOS版本的iCloud API可能有差异
+  - 某些老版本设备可能不支持
+  - iCloud服务可用性受网络环境影响
+
+## 相关 API
+
+- [`SaveToSd`](./028-SaveToSd.md) - 保存在线图片
+- [`SaveBase64ImageToSd`](./029-SaveBase64ImageToSd.md) - 保存base64图片
+- [`UploadPhoto`](./025-UploadPhoto.md) - 选择图片
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息

package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/013-GoToMap.md

@@ -0,0 +1,83 @@
+---
+date: 2026-03-06
+permalink: /pages/api-go-to-map/
+categories: 
+  - API
+  - 页面跳转
+  - 地图功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# GoToMap - 跳转地图页面
+
+## 功能描述
+
+跳转页面并插入高德地图做关键词搜索。Web端只做页面跳转，APP端会集成高德地图功能。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GoToMap(option: { 
+  Url: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Url | string | 是 | 页面地址 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 跳转到地图页面
+mixPublicLib.GoToMap({ Url: "map-search" });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { GotoInsideType } from './paramsTypes';
+
+const options: GotoInsideType = { Url: "map-search" };
+
+mixPublicLib.GoToMap(options);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 通过 `Goto()` 方法跳转到指定页面URL
+- **APP端**: 跳转到指定页面并集成高德地图关键词搜索功能
+
+### 使用场景
+
+- 需要跳转到专门的地图搜索页面时使用
+- 适用于位置搜索、地点查找等业务场景
+- 目标页面需要实现地图相关的UI和逻辑
+
+## 注意事项
+
+- Url 参数必须是有效的页面路径
+- APP端需要在OMEGA项目中配置高德地图相关参数
+- Web端不会自动集成地图功能，需要在目标页面自行实现
+- 此方法本身不包含搜索关键词，关键词需要在目标页面处理
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`GetLocation`](./063-GetLocation.md) - 获取地理位置
+- [`OpenAmap`](./105-OpenAmap.md) - 打开高德地图

package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/014-MapSearch.md

@@ -0,0 +1,81 @@
+---
+date: 2026-03-06
+permalink: /pages/api-map-search/
+categories: 
+  - API
+  - 地图功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# MapSearch - 高德地图搜索
+
+## 功能描述
+
+跳转高德地图做关键词搜索。Web端只跳转高德地图，APP端会直接在高德地图中进行关键词搜索。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+MapSearch(option: { 
+  KeyWord: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| KeyWord | string | 是 | 地图搜索关键词 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 在高德地图中搜索关键词
+mixPublicLib.MapSearch({ KeyWord: "天安门" });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { MapSearchType } from './paramsTypes';
+
+const options: MapSearchType = { KeyWord: "天安门" };
+
+mixPublicLib.MapSearch(options);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 跳转到高德地图官网（https://uri.amap.com）
+- **APP端**: 直接调用高德地图APP并进行关键词搜索
+
+### 使用场景
+
+- 需要快速在高德地图中搜索地点时使用
+- 适用于位置查询、导航等业务场景
+- 可以搜索任何有效的地点名称或地址
+
+## 注意事项
+
+- KeyWord 参数不能为空
+- APP端需要设备已安装高德地图APP
+- Web端只是跳转到高德地图官网，不会自动执行搜索
+- 搜索结果的准确性取决于高德地图的数据质量
+
+## 相关 API
+
+- [`GetLocation`](./063-GetLocation.md) - 获取地理位置
+- [`GoToMap`](./013-GoToMap.md) - 打开地图

package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/063-GetLocation.md

@@ -0,0 +1,173 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-location/
+categories: 
+  - API
+  - 位置服务
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetLocation - 获取地理位置
+
+## 功能描述
+
+获取设备当前的地理位置信息。返回包含经纬度、地址等信息的对象。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+GetLocation(): Promise<GetLocationType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+#### GetLocationType 接口定义
+
+```typescript
+interface GetLocationType {
+  latitude: number;
+  longitude: number;
+  speed: number;
+  accuracy: number;
+  altitude: number;
+  verticalAccuracy: number;
+  horizontalAccuracy: number;
+  address?: string;
+}
+```
+
+### 返回值说明
+
+Promise<GetLocationType> - 返回地理位置信息对象，包含以下字段：
+- latitude: 纬度
+- longitude: 经度  
+- speed: 速度（单位：m/s）
+- accuracy: 位置精度（单位：m）
+- altitude: 高度（单位：m）
+- verticalAccuracy: 垂直精度（单位：m）
+- horizontalAccuracy: 水平精度（单位：m）
+- address: 详细地址（仅当isAddress为true时返回）
+
+## 代码示例
+
+### JavaScript 示例
+
+```
+// 获取基本位置信息（仅经纬度）
+mixPublicLib.GetLocation()
+  .then(location => {
+    console.log("位置信息:", location);
+    console.log(`纬度: ${location.latitude}, 经度: ${location.longitude}`);
+  })
+  .catch(error => {
+    console.error("获取位置失败:", error);
+  });
+
+// 获取详细位置信息（包含地址）
+mixPublicLib.GetLocation({ isAddress: true })
+  .then(location => {
+    console.log("详细位置信息:", location);
+    console.log(`地址: ${location.address}`);
+    console.log(`坐标: (${location.latitude}, ${location.longitude})`);
+  })
+  .catch(error => {
+    console.error("获取详细位置失败:", error);
+  });
+```
+
+### TypeScript 示例
+
+```
+import type { GetLocationParamsType, GetLocationType } from './paramsTypes';
+
+// 基本位置获取
+mixPublicLib.GetLocation()
+  .then((location: GetLocationType) => {
+    console.log(`当前位置: ${location.latitude}, ${location.longitude}`);
+  })
+  .catch((error: any) => {
+    console.error("位置获取失败:", error);
+  });
+
+// 详细位置获取
+const options: GetLocationParamsType = { isAddress: true };
+mixPublicLib.GetLocation(options)
+  .then((location: GetLocationType) => {
+    if (location.address) {
+      console.log(`详细地址: ${location.address}`);
+    }
+  })
+  .catch((error: any) => {
+    console.error("详细位置获取失败:", error);
+  });
+```
+
+## 使用说明
+
+### 参数选项
+
+- **isAddress: false** (默认): 仅返回经纬度和基本位置信息
+- **isAddress: true**: 返回完整的地理位置信息，包括详细地址
+
+### 平台差异
+
+- **Web端**: 使用浏览器Geolocation API，可能需要HTTPS
+- **APP端**: 调用原生定位服务，支持高精度定位
+- **iOS/Android**: 原生实现，支持GPS、WiFi、基站等多种定位方式
+
+### 精度说明
+
+- **accuracy**: 位置的总体精度
+- **horizontalAccuracy**: 水平方向的精度
+- **verticalAccuracy**: 垂直方向的精度（高度精度）
+- **altitude**: 海拔高度（可能不准确）
+
+### 使用场景
+
+- 地图应用的位置标记
+- 附近服务的搜索和推荐
+- 位置签到功能
+- 运动轨迹记录
+- 天气信息获取
+- 地理围栏应用
+
+## 注意事项
+
+- **权限要求**: 
+  - 必须获得用户的位置权限授权
+  - Web端需要HTTPS环境（除localhost外）
+  - iOS需要在Info.plist中配置位置权限描述
+  - Android需要在Manifest中声明位置权限
+- **隐私考虑**: 
+  - 位置信息属于敏感个人信息
+  - 应明确告知用户位置使用的用途
+  - 遵守相关隐私法规和平台政策
+- **性能影响**: 
+  - 高精度定位会消耗更多电量
+  - 获取地址信息需要网络请求，可能较慢
+  - 建议根据实际需求选择合适的精度级别
+- **错误处理**: 
+  - 用户拒绝权限时会抛出异常
+  - 设备无GPS或网络时可能定位失败
+  - 建议提供优雅的降级方案
+- **最佳实践**: 
+  - 仅在必要时请求位置信息
+  - 提供手动输入位置的替代方案
+  - 缓存位置信息避免频繁请求
+  - 在后台时停止位置更新以节省电量
+
+## 相关 API
+
+- [`MapSearch`](./014-MapSearch.md) - 地图搜索
+- [`GoToMap`](./013-GoToMap.md) - 打开地图
+- [`OpenAmap`](./105-OpenAmap.md) - 打开高德地图
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息

package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/105-OpenAmap.md

@@ -0,0 +1,151 @@
+---
+date: 2026-03-06
+permalink: /pages/api-open-amap/
+categories: 
+  - API
+  - 地图功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# OpenAmap - 打开高德地图
+
+## 功能描述
+
+打开高德地图应用。用于在高德地图中显示位置或进行导航。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+OpenAmap(option: OpenAmapType): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | OpenAmapType | 是 | 高德地图配置对象 | {} |
+
+#### OpenAmapType 接口定义
+
+```typescript
+interface OpenAmapType {
+  latitude: number;
+  longitude: number;
+  name?: string;
+}
+```
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 打开高德地图显示指定位置
+mixPublicLib.OpenAmap({
+  latitude: 39.9042,
+  longitude: 116.4074,
+  name: "北京天安门"
+});
+
+// 仅使用经纬度打开地图
+mixPublicLib.OpenAmap({
+  latitude: 31.2304,
+  longitude: 121.4737
+});
+
+// 在获取用户位置后打开高德地图
+function openMapAtCurrentLocation() {
+  mixPublicLib.GetLocation()
+    .then(location => {
+      mixPublicLib.OpenAmap({
+        latitude: location.latitude,
+        longitude: location.longitude,
+        name: "当前位置"
+      });
+    })
+    .catch(error => {
+      console.error("获取位置失败:", error);
+    });
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { OpenAmapType } from './paramsTypes';
+
+// 打开高德地图
+const mapOptions: OpenAmapType = {
+  latitude: 39.9042,
+  longitude: 116.4074,
+  name: "北京天安门"
+};
+mixPublicLib.OpenAmap(mapOptions);
+```
+
+## 使用说明
+
+### 参数说明
+
+- **latitude**: 目标位置的纬度（必填）
+- **longitude**: 目标位置的经度（必填）
+- **name**: 位置名称（可选，用于在地图上显示标注）
+
+### 坐标系统
+
+- **WGS84**: 标准GPS坐标系
+- **GCJ02**: 中国国测局坐标系（高德地图使用）
+- 建议使用标准WGS84坐标，SDK会自动转换
+
+### 平台差异
+
+- **APP端**: 调用高德地图APP（如果已安装）或跳转到网页版
+- **Web端**: 可能跳转到高德地图网页版
+- **小程序**: 可能调用小程序的地图组件
+
+### 使用场景
+
+- 商家位置导航
+- 用户当前位置显示
+- POI（兴趣点）搜索结果展示
+- 路线规划和导航
+- 地理位置分享
+
+## 注意事项
+
+- **应用依赖**: 
+  - APP端需要用户安装高德地图应用
+  - 如果未安装，可能跳转到应用商店或网页版
+  - Web端直接跳转到高德地图网站
+- **坐标精度**: 
+  - 纬度范围：-90 到 90
+  - 经度范围：-180 到 180
+  - 建议验证坐标的有效性
+- **用户体验**: 
+  - 提供明确的位置信息
+  - 考虑用户的位置隐私
+  - 处理高德地图未安装的情况
+- **最佳实践**: 
+  - 结合 `GetLocation` 获取用户当前位置
+  - 提供其他地图应用的备选方案
+  - 测试不同设备上的地图打开效果
+  - 考虑网络环境对地图加载的影响
+- **兼容性**: 
+  - 不同平台的地图打开方式可能不同
+  - 某些地区可能限制高德地图访问
+  - 老版本高德地图可能有兼容性问题
+
+## 相关 API
+
+- [`GetLocation`](./063-GetLocation.md) - 获取地理位置
+- [`GoToMap`](./013-GoToMap.md) - 打开地图
+- [`MapSearch`](./014-MapSearch.md) - 地图搜索

package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/010-LoginOut.md

@@ -0,0 +1,77 @@
+---
+date: 2026-03-06
+permalink: /pages/api-login-out/
+categories: 
+  - API
+  - 页面跳转
+  - 用户认证
+tags: []
+author: { name: AI Assistant }
+---
+
+# LoginOut - 退出登录
+
+## 功能描述
+
+退出APP至登录页面。用于用户登出操作，跳转到预设的登录页面。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+LoginOut(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 退出登录
+mixPublicLib.LoginOut();
+```
+
+### TypeScript 示例
+
+```typescript
+// 退出登录
+mixPublicLib.LoginOut();
+```
+
+## 使用说明
+
+### 使用场景
+
+- 用户主动登出时调用
+- 会话过期需要重新登录时调用
+- 安全退出当前账户时调用
+
+### 实现方式
+
+- Web端通过 `Goto()` 方法跳转到预设的登录页面（`user-login`）
+- APP端通过原生导航实现跳转到登录页面
+
+## 注意事项
+
+- 登录页面URL固定为 `user-login`
+- 此操作不会自动清除用户数据，如需清除请配合其他方法使用
+- Web端和APP端的行为一致
+
+## 相关 API
+
+- [`AutoLogin`](./084-AutoLogin.md) - 自动登录
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`ClearAppCache`](./073-ClearAppCache.md) - 清理APP缓存