mix-public 1.2.0 → 1.2.2

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

@@ -0,0 +1,131 @@
+---
+date: 2026-03-06
+permalink: /pages/api-replace-app-icon/
+categories: 
+  - API
+  - 应用控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# ReplaceAppIcon - 替换应用图标
+
+## 功能描述
+
+替换应用的桌面图标。用于动态更改应用在设备桌面上显示的图标。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+ReplaceAppIcon(option: { 
+  IconPath: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| IconPath | string | 是 | 新图标文件路径 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 替换应用图标
+mixPublicLib.ReplaceAppIcon({ 
+  IconPath: "/path/to/new-icon.png" 
+});
+
+// 从网络下载图标后替换
+async function downloadAndReplaceIcon(iconUrl) {
+  try {
+    const response = await fetch(iconUrl);
+    const blob = await response.blob();
+    const localPath = await saveBlobToLocal(blob); // 假设的保存函数
+    mixPublicLib.ReplaceAppIcon({ IconPath: localPath });
+  } catch (error) {
+    console.error("图标替换失败:", error);
+  }
+}
+
+// 根据节日主题替换图标
+const currentDate = new Date();
+if (currentDate.getMonth() === 11 && currentDate.getDate() === 25) {
+  // 圣诞节
+  mixPublicLib.ReplaceAppIcon({ IconPath: "/assets/christmas-icon.png" });
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { ReplaceAppIconType } from './paramsTypes';
+
+// 替换应用图标
+const iconOptions: ReplaceAppIconType = {
+  IconPath: "/path/to/new-icon.png"
+};
+mixPublicLib.ReplaceAppIcon(iconOptions);
+```
+
+## 使用说明
+
+### 图标要求
+
+- **格式**: 通常支持PNG、JPEG等常见图片格式
+- **尺寸**: 建议使用高分辨率图标（如1024x1024），系统会自动缩放
+- **路径**: 必须是本地文件系统路径，不支持网络URL
+
+### 平台差异
+
+- **iOS**: 支持动态更换应用图标（iOS 10.3+）
+- **Android**: 支持情况取决于设备厂商和启动器
+- **Web端**: 不支持更换浏览器标签页图标（favicon）
+
+### 使用场景
+
+- 节日主题图标切换
+- 用户自定义应用图标
+- A/B测试的不同图标版本
+- 应用状态指示（如未读消息数量）
+- 品牌推广活动的临时图标
+
+## 注意事项
+
+- **平台限制**: 
+  - iOS需要在Info.plist中预定义可选图标
+  - Android支持情况因设备而异
+  - Web端完全不支持此功能
+- **权限要求**: 
+  - iOS需要用户确认图标更换
+  - Android可能需要特殊权限
+  - 某些设备可能完全禁止第三方应用更换图标
+- **用户体验**: 
+  - 图标更换可能需要几秒钟生效
+  - 用户可能会感到困惑如果图标突然改变
+  - 建议提供明确的用户通知和说明
+- **最佳实践**: 
+  - 提供图标更换的用户控制选项
+  - 在合适的时机进行图标更换（如节日、活动）
+  - 测试不同设备上的兼容性
+  - 提供恢复默认图标的选项
+- **技术限制**: 
+  - 图标文件必须存在于本地存储
+  - 某些系统可能缓存图标，需要重启才能看到变化
+  - 更换后的图标可能无法立即在所有位置显示
+
+## 相关 API
+
+- [`GetAppIconsPath`](./075-GetAppIconsPath.md) - 获取应用图标路径
+- [`GetAppVersion`](./069-GetAppVersion.md) - 获取应用版本
+- [`SetBadgeValue`](./056-SetBadgeValue.md) - 设置应用角标

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

@@ -0,0 +1,137 @@
+---
+date: 2026-03-06
+permalink: /pages/api-set-application-icon-badge-number/
+categories: 
+  - API
+  - 应用控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# SetApplicationIconBadgeNumber - 设置应用图标角标数字
+
+## 功能描述
+
+设置应用图标右上角的数字角标。用于显示未读消息数量或其他通知计数。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SetApplicationIconBadgeNumber(option: { 
+  badgeNumber: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| badgeNumber | number | 是 | 角标数字（0表示清除角标） | 0 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置应用图标角标为5
+mixPublicLib.SetApplicationIconBadgeNumber({ 
+  badgeNumber: 5 
+});
+
+// 清除应用图标角标
+mixPublicLib.SetApplicationIconBadgeNumber({ 
+  badgeNumber: 0 
+});
+
+// 动态更新角标
+let unreadMessages = 10;
+mixPublicLib.SetApplicationIconBadgeNumber({ 
+  badgeNumber: unreadMessages 
+});
+
+// 在收到新消息时更新角标
+function onNewMessage() {
+  unreadMessages++;
+  mixPublicLib.SetApplicationIconBadgeNumber({ 
+    badgeNumber: unreadMessages 
+  });
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SetApplicationIconBadgeNumberType } from './paramsTypes';
+
+// 设置角标
+const badgeOptions: SetApplicationIconBadgeNumberType = {
+  badgeNumber: 5
+};
+mixPublicLib.SetApplicationIconBadgeNumber(badgeOptions);
+
+// 清除角标
+const clearOptions: SetApplicationIconBadgeNumberType = {
+  badgeNumber: 0
+};
+mixPublicLib.SetApplicationIconBadgeNumber(clearOptions);
+```
+
+## 使用说明
+
+### 角标数字说明
+
+- **badgeNumber > 0**: 显示对应的数字角标
+- **badgeNumber = 0**: 清除或隐藏角标
+- **badgeNumber < 0**: 通常不支持负数，可能被忽略或转换为0
+
+### 平台差异
+
+- **iOS**: 完全支持应用图标角标，显示在应用图标右上角
+- **Android**: 支持情况取决于设备厂商和启动器，部分设备可能不显示
+- **Web端**: 通常不支持应用图标角标功能
+
+### 使用场景
+
+- 显示未读消息数量
+- 通知计数显示
+- 待处理任务数量
+- 应用内重要事件提醒
+- 用户活跃度指标
+
+## 注意事项
+
+- **平台限制**: 
+  - 此功能主要在移动APP环境中有效
+  - Web端调用此方法通常不会产生实际效果
+  - Android设备的角标支持因厂商而异
+- **用户体验**: 
+  - 角标数字建议控制在合理范围内（通常99以内）
+  - 过大的数值可能被截断显示（如"99+"）
+  - 及时更新角标以反映最新状态
+- **权限要求**: 
+  - iOS通常不需要特殊权限
+  - Android可能需要通知权限
+  - 某些设备可能需要用户手动开启角标显示
+- **最佳实践**: 
+  - 在数据变化时及时更新角标数值
+  - 提供清除角标的用户操作
+  - 结合推送通知使用
+  - 测试不同设备上的显示效果
+- **兼容性**: 
+  - 不同Android厂商的角标实现可能不同
+  - 某些启动器可能完全不支持角标
+  - 老版本系统可能有兼容性问题
+
+## 相关 API
+
+- [`ClearApplicationIconBadgeNumber`](./083-ClearApplicationIconBadgeNumber.md) - 清除应用图标角标数字
+- [`SetBadgeValue`](./056-SetBadgeValue.md) - 设置应用角标
+- [`ClearBadgeValue`](./057-ClearBadgeValue.md) - 清除应用角标

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

@@ -0,0 +1,122 @@
+---
+date: 2026-03-06
+permalink: /pages/api-clear-application-icon-badge-number/
+categories: 
+  - API
+  - 应用控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# ClearApplicationIconBadgeNumber - 清除应用图标角标数字
+
+## 功能描述
+
+清除应用图标右上角的数字角标。用于移除通知计数或未读消息提示。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+ClearApplicationIconBadgeNumber(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 清除应用图标角标
+mixPublicLib.ClearApplicationIconBadgeNumber();
+
+// 在用户查看所有消息后清除角标
+function onAllMessagesRead() {
+  mixPublicLib.ClearApplicationIconBadgeNumber();
+  console.log("所有消息已读，角标已清除");
+}
+
+// 在应用启动时清理旧的角标
+document.addEventListener('DOMContentLoaded', () => {
+  mixPublicLib.ClearApplicationIconBadgeNumber();
+});
+```
+
+### TypeScript 示例
+
+```typescript
+// 清除应用图标角标
+mixPublicLib.ClearApplicationIconBadgeNumber();
+
+// 带错误处理的角标清除
+try {
+  mixPublicLib.ClearApplicationIconBadgeNumber();
+  console.log("角标清除成功");
+} catch (error) {
+  console.error("角标清除失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 完全移除应用图标上的数字角标
+- 等效于调用 `SetApplicationIconBadgeNumber({ badgeNumber: 0 })`
+- 清除所有相关的通知计数显示
+
+### 平台差异
+
+- **iOS**: 完全支持清除应用图标角标
+- **Android**: 支持情况取决于设备厂商和启动器
+- **Web端**: 通常不支持应用图标角标功能
+
+### 使用场景
+
+- 用户已读取所有通知后清除角标
+- 应用启动时清理旧的角标
+- 手动清除不需要的通知计数
+- 应用退出时清理状态
+- 用户主动清理通知状态
+
+## 注意事项
+
+- **平台限制**: 
+  - 此功能主要在移动APP环境中有效
+  - Web端调用此方法通常不会产生实际效果
+  - Android设备的角标清除支持因厂商而异
+- **用户体验**: 
+  - 清除操作可能有短暂延迟
+  - 某些设备可能需要手动刷新才能看到变化
+  - 建议在适当的时机调用此方法
+- **权限要求**: 
+  - iOS通常不需要特殊权限
+  - Android可能需要通知权限
+  - 某些设备可能需要用户授权角标管理
+- **最佳实践**: 
+  - 在用户完成相关操作后立即清除角标
+  - 提供手动清除角标的用户选项
+  - 结合具体的业务逻辑使用
+  - 测试不同设备上的清除效果
+- **兼容性**: 
+  - 不同Android厂商的角标实现可能不同
+  - 某些启动器可能完全不支持角标清除
+  - 老版本系统可能有兼容性问题
+
+## 相关 API
+
+- [`SetApplicationIconBadgeNumber`](./082-SetApplicationIconBadgeNumber.md) - 设置应用图标角标数字
+- [`SetBadgeValue`](./056-SetBadgeValue.md) - 设置应用角标
+- [`ClearBadgeValue`](./057-ClearBadgeValue.md) - 清除应用角标

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

@@ -0,0 +1,118 @@
+---
+date: 2026-03-06
+permalink: /pages/api-auto-login/
+categories: 
+  - API
+  - 用户认证
+tags: []
+author: { name: AI Assistant }
+---
+
+# AutoLogin - 自动登录
+
+## 功能描述
+
+执行自动登录操作。用于在应用启动时自动验证用户身份并登录。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+AutoLogin({ Url: "" }): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Url | string | 是 | 自动登录跳转URL | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 执行自动登录
+mixPublicLib.AutoLogin({ Url: "" })
+  
+
+// 在应用启动时执行自动登录
+document.addEventListener('DOMContentLoaded', () => {
+  mixPublicLib.AutoLogin({ Url: "" })
+});
+```
+
+### TypeScript 示例
+
+```typescript
+// 执行自动登录
+mixPublicLib.AutoLogin({ Url: "" })
+
+```
+
+## 使用说明
+
+### 功能说明
+
+- 验证本地存储的用户凭证（如token、session等）
+- 自动向服务器验证用户身份
+- 在凭证有效的情况下完成登录流程
+- 返回登录操作的成功或失败状态
+
+### 平台差异
+
+- **Web端**: 使用localStorage/sessionStorage中的凭证进行验证
+- **APP端**: 使用原生存储的凭证进行验证
+- **小程序**: 使用小程序存储的凭证进行验证
+
+### 登录流程
+
+1. 检查本地是否存在有效的用户凭证
+2. 向服务器发送凭证验证请求
+3. 验证成功后更新用户状态
+4. 返回登录结果
+
+### 使用场景
+
+- 应用启动时的自动登录
+- 用户会话保持
+- 免密码快速登录
+- 后台服务的自动认证
+- 单点登录（SSO）集成
+
+## 注意事项
+
+- **安全性**: 
+  - 凭证应该安全存储和传输
+  - 避免在客户端暴露敏感的认证信息
+  - 遵守相关的安全和隐私规范
+- **用户体验**: 
+  - 自动登录失败时应提供明确的错误提示
+  - 提供手动登录的备用方案
+  - 考虑用户的登录偏好设置
+- **最佳实践**: 
+  - 在应用启动时立即执行自动登录
+  - 结合生物识别等安全验证方式
+  - 定期刷新和验证用户凭证
+  - 处理网络异常和服务器错误
+- **兼容性**: 
+  - 不同平台的凭证存储机制可能不同
+  - 老版本应用可能使用不同的认证方式
+  - 某些网络环境可能影响登录验证
+- **错误处理**: 
+  - 凭证过期时应引导用户重新登录
+  - 网络错误时应提供重试选项
+  - 服务器错误时应提供友好的错误提示
+
+## 相关 API
+
+- [`getBiometricRecognition`](./077-getBiometricRecognition.md) - 获取生物识别支持状态
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`LoginOut`](./010-LoginOut.md) - 退出登录

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

@@ -0,0 +1,132 @@
+---
+date: 2026-03-06
+permalink: /pages/api-init-cloud-channel/
+categories: 
+  - API
+  - 推送通知
+tags: []
+author: { name: AI Assistant }
+---
+
+# InitCloudChannel - 初始化云通道
+
+## 功能描述
+
+初始化云推送通道。用于设置和配置云端推送服务的基础参数。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+InitCloudChannel(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 初始化云通道
+mixPublicLib.InitCloudChannel();
+
+// 在应用启动时初始化云通道
+document.addEventListener('DOMContentLoaded', () => {
+  mixPublicLib.InitCloudChannel();
+  console.log("云通道初始化完成");
+});
+
+// 结合其他推送操作使用
+mixPublicLib.InitCloudChannel();
+// 初始化完成后可以绑定设备
+setTimeout(() => {
+  mixPublicLib.BindCloudChannel();
+}, 1000);
+```
+
+### TypeScript 示例
+
+```typescript
+// 初始化云通道
+mixPublicLib.InitCloudChannel();
+
+// 带错误处理的初始化操作
+try {
+  mixPublicLib.InitCloudChannel();
+  console.log("云通道初始化成功");
+} catch (error) {
+  console.error("云通道初始化失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 配置云端推送服务的基础参数
+- 初始化推送SDK或服务
+- 设置推送通道的必要配置
+- 为后续的绑定和推送操作做准备
+
+### 平台差异
+
+- **iOS**: 初始化APNs（Apple Push Notification service）配置
+- **Android**: 初始化FCM（Firebase Cloud Messaging）或其他推送服务
+- **Web端**: 可能不支持或提供模拟功能
+
+### 初始化流程
+
+1. 加载推送服务的配置参数
+2. 初始化推送SDK
+3. 验证必要的权限和依赖
+4. 准备推送通道的基础环境
+
+### 使用场景
+
+- 应用启动时的推送服务初始化
+- 用户登录前的推送环境准备
+- 推送功能恢复时的重新初始化
+- 设备更换后的推送服务重置
+
+## 注意事项
+
+- **调用时机**: 
+  - 应该在应用启动早期调用
+  - 在 `BindCloudChannel` 之前调用
+  - 避免重复初始化
+- **平台限制**: 
+  - Web端通常不支持原生推送通道初始化
+  - 老版本操作系统可能有兼容性问题
+  - 某些地区可能限制推送服务
+- **用户体验**: 
+  - 初始化过程通常是后台进行的
+  - 用户通常不会感知到初始化过程
+  - 初始化成功后才能正常使用推送功能
+- **最佳实践**: 
+  - 在应用入口处统一初始化
+  - 结合错误处理确保初始化可靠性
+  - 测试不同网络环境下的初始化效果
+  - 考虑离线情况下的初始化策略
+- **安全性**: 
+  - 确保初始化过程的安全传输
+  - 避免在初始化过程中泄露敏感信息
+  - 遵守相关的隐私和安全规范
+
+## 相关 API
+
+- [`BindCloudChannel`](./079-BindCloudChannel.md) - 绑定云通道
+- [`UnbindCloudChannel`](./080-UnbindCloudChannel.md) - 解绑云通道
+- [`GetApnsAuthorizationStatus`](./064-GetApnsAuthorizationStatus.md) - 获取推送授权状态
+- [`SettingApns`](./068-SettingApns.md) - 推送设置