mix-public 1.2.0 → 1.2.2

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/062-IsNet.md

@@ -0,0 +1,133 @@
+---
+date: 2026-03-06
+permalink: /pages/api-is-net/
+categories: 
+  - API
+  - 网络状态
+tags: []
+author: { name: AI Assistant }
+---
+
+# IsNet - 检测网络状态
+
+## 功能描述
+
+检测设备当前的网络连接状态。返回字符串表示是否有网络连接。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+IsNet(): string
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+string - 返回网络连接状态（"1"": 有网络连接，"0"": 无网络连接）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 检测网络状态
+const hasNetwork = mixPublicLib.IsNet();
+console.log("网络状态:", hasNetwork ? "已连接" : "未连接");
+
+// 根据网络状态执行不同逻辑
+if (hasNetwork) {
+  console.log("可以执行网络请求");
+  // 执行需要网络的操作
+} else {
+  console.log("网络不可用，请检查网络设置");
+  // 显示离线提示或使用缓存数据
+}
+
+// 定期检测网络状态
+setInterval(() => {
+  const networkStatus = mixPublicLib.IsNet();
+  if (!networkStatus) {
+    alert("网络连接已断开");
+  }
+}, 5000);
+```
+
+### TypeScript 示例
+
+```typescript
+// 检测网络状态
+const hasNetwork: boolean = mixPublicLib.IsNet();
+console.log(`网络状态: ${hasNetwork ? "已连接" : "未连接"}`);
+
+// 类型安全的网络状态处理
+if (hasNetwork) {
+  console.log("执行在线操作");
+} else {
+  console.log("执行离线操作");
+}
+```
+
+## 使用说明
+
+### 返回值说明
+
+- **true**: 设备有有效的网络连接（WiFi、移动数据等）
+- **false**: 设备没有网络连接或网络连接不可用
+
+### 平台差异
+
+- **Web端**: 使用 `navigator.onLine` 或尝试连接测试服务器
+- **APP端**: 调用原生网络状态检测API
+- **iOS/Android**: 原生实现，检测更准确
+
+### 检测方式
+
+- **Web端**: 
+  - 基于浏览器的online/offline事件
+  - 可能无法检测到弱网或代理问题
+- **APP端**: 
+  - 检测实际的网络接口状态
+  - 可能包含对特定服务器的连通性测试
+
+### 使用场景
+
+- 网络请求前的状态检查
+- 离线模式的自动切换
+- 用户网络状态提示
+- 数据同步功能的条件判断
+- 应用启动时的网络验证
+
+## 注意事项
+
+- **检测局限性**: 
+  - 返回true不一定表示可以访问特定服务
+  - 可能无法检测到网络质量或防火墙限制
+  - 某些情况下可能有短暂的检测延迟
+- **平台差异**: 
+  - Web端的检测可能不够准确
+  - APP端通常提供更可靠的网络状态信息
+- **最佳实践**: 
+  - 即使检测到有网络，也应该处理网络请求失败的情况
+  - 建议结合具体的网络请求错误处理
+  - 对于关键操作，可以进行实际的连通性测试
+- **性能考虑**: 
+  - 频繁调用可能影响性能
+  - 建议在必要时调用，避免轮询
+- **用户体验**: 
+  - 网络状态变化时及时通知用户
+  - 提供离线功能以提升用户体验
+
+## 相关 API
+
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示
+- [`OnlineService`](./104-OnlineService.md) - 在线客服

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/064-GetApnsAuthorizationStatus.md

@@ -0,0 +1,132 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-apns-authorization-status/
+categories: 
+  - API
+  - 推送通知
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetApnsAuthorizationStatus - 获取推送授权状态
+
+## 功能描述
+
+获取APNs（Apple Push Notification service）推送通知的授权状态。用于检查用户是否允许应用发送推送通知。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetApnsAuthorizationStatus(): number
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+number - 返回推送授权状态码：
+- 0: 未请求权限或拒绝权限
+- 1: 已授权推送权限
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取推送授权状态
+const authStatus = mixPublicLib.GetApnsAuthorizationStatus();
+console.log("推送授权状态:", authStatus);
+
+// 根据授权状态执行不同逻辑
+if (authStatus === 1) {
+  console.log("用户已授权推送通知");
+  // 可以注册推送服务
+} else {
+  console.log("用户未授权推送通知");
+  // 提示用户开启推送权限
+  alert("请在设置中开启推送通知权限");
+}
+
+// 检查并引导用户开启推送
+function checkPushPermission() {
+  const status = mixPublicLib.GetApnsAuthorizationStatus();
+  if (status !== 1) {
+    showPushPermissionGuide();
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取推送授权状态
+const authStatus: number = mixPublicLib.GetApnsAuthorizationStatus();
+console.log(`推送授权状态: ${authStatus}`);
+
+// 类型安全的状态处理
+if (authStatus === 1) {
+  console.log("推送权限已授权");
+} else {
+  console.log("推送权限未授权");
+}
+```
+
+## 使用说明
+
+### 状态码说明
+
+- **0**: 表示以下情况之一：
+  - 应用从未请求过推送权限
+  - 用户明确拒绝了推送权限
+  - 设备不支持推送通知
+- **1**: 表示用户已授权应用发送推送通知
+
+### 平台差异
+
+- **iOS**: 完全支持APNs推送授权状态检测
+- **Android**: 可能返回模拟值或基于Android通知权限的状态
+- **Web端**: 通常返回0（不支持推送通知）
+
+### 使用场景
+
+- 应用启动时检查推送权限状态
+- 决定是否显示推送权限引导
+- 推送功能的条件性启用
+- 用户设置页面的权限状态显示
+- 推送订阅管理
+
+## 注意事项
+
+- **平台限制**: 
+  - 此功能主要针对iOS平台的APNs服务
+  - Android平台使用不同的推送机制（如FCM）
+  - Web端通常不支持原生推送通知
+- **权限时机**: 
+  - iOS应用需要先调用推送权限请求才能获取准确状态
+  - 首次安装应用时状态通常为0
+- **用户体验**: 
+  - 不要频繁检查推送权限状态
+  - 在合适的时机引导用户开启推送权限
+  - 提供推送权限的价值说明
+- **兼容性**: 
+  - 老版本iOS可能有不同的行为
+  - 某些设备可能禁用了推送功能
+- **最佳实践**: 
+  - 结合具体的业务场景使用推送功能
+  - 提供推送权限的开关选项
+  - 尊重用户的选择，不要强制要求推送权限
+
+## 相关 API
+
+- [`SettingApns`](./068-SettingApns.md) - 推送设置
+- [`IsOpenPushSound`](./078-IsOpenPushSound.md) - 是否开启推送声音
+- [`BindCloudChannel`](./079-BindCloudChannel.md) - 绑定云通道
+- [`UnbindCloudChannel`](./080-UnbindCloudChannel.md) - 解绑云通道

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/068-SettingApns.md

@@ -0,0 +1,116 @@
+---
+date: 2026-03-06
+permalink: /pages/api-setting-apns/
+categories: 
+  - API
+  - 推送通知
+tags: []
+author: { name: AI Assistant }
+---
+
+# SettingApns - 推送设置
+
+## 功能描述
+
+打开系统推送通知设置页面。用于引导用户到系统设置中配置应用的推送权限。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SettingApns(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 打开推送设置页面
+mixPublicLib.SettingApns();
+
+// 在检测到推送未授权时引导用户设置
+const authStatus = mixPublicLib.GetApnsAuthorizationStatus();
+if (authStatus !== 1) {
+  if (confirm("推送通知未开启，是否前往设置？")) {
+    mixPublicLib.SettingApns();
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 打开推送设置页面
+mixPublicLib.SettingApns();
+
+// 类型安全的推送状态检查
+const authStatus: number = mixPublicLib.GetApnsAuthorizationStatus();
+if (authStatus !== 1) {
+  // 引导用户开启推送
+  mixPublicLib.SettingApns();
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 跳转到系统设置页面中应用的推送通知配置项
+- 允许用户手动开启或关闭推送通知权限
+- 提供推送设置的直接入口
+
+### 平台差异
+
+- **iOS**: 跳转到iOS系统设置中的应用通知设置页面
+- **Android**: 跳转到Android系统设置中的应用通知设置页面
+- **Web端**: 可能不支持或提供模拟功能（控制台提示）
+
+### 使用场景
+
+- 用户拒绝推送权限后的引导操作
+- 应用设置页面中的推送开关
+- 推送功能无法正常工作时的故障排除
+- 用户主动管理推送设置的需求
+
+## 注意事项
+
+- **平台限制**: 
+  - Web端通常不支持跳转到系统设置
+  - 某些Android版本的设置页面路径可能不同
+  - iOS 10+ 支持直接跳转到应用设置页面
+- **用户体验**: 
+  - 跳转后用户需要手动操作才能返回应用
+  - 建议在跳转前提示用户操作目的
+  - 提供清晰的操作指引
+- **权限状态**: 
+  - 此方法不会自动开启推送权限
+  - 用户仍需要在设置页面中手动开启
+  - 跳转后应用无法获知用户的最终选择
+- **最佳实践**: 
+  - 结合 `GetApnsAuthorizationStatus` 使用
+  - 在合适的时机提供设置入口
+  - 提供推送功能的价值说明
+  - 尊重用户的选择，不要强制要求
+- **兼容性**: 
+  - 老版本操作系统可能不支持直接跳转
+  - 某些设备厂商可能有自定义的设置页面
+
+## 相关 API
+
+- [`GetApnsAuthorizationStatus`](./064-GetApnsAuthorizationStatus.md) - 获取推送授权状态
+- [`IsOpenPushSound`](./078-IsOpenPushSound.md) - 是否开启推送声音
+- [`BindCloudChannel`](./079-BindCloudChannel.md) - 绑定云通道

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/078-IsOpenPushSound.md

@@ -0,0 +1,117 @@
+---
+date: 2026-03-06
+permalink: /pages/api-is-open-push-sound/
+categories: 
+  - API
+  - 推送通知
+tags: []
+author: { name: AI Assistant }
+---
+
+# IsOpenPushSound - 是否开启推送声音
+
+## 功能描述
+
+开启/关闭推送通知的声音提醒
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+IsOpenPushSound({ 
+  IsOpen: number
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| IsOpen | number | 是 | 是否开启音效（1:开启 0: 不开启） | 0 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 调整推送声音状态
+//关闭推送声音
+mixPublicLib.IsOpenPushSound({ IsOpen: 0 });
+
+//开启推送声音
+mixPublicLib.IsOpenPushSound({ IsOpen: 1 });
+
+```
+
+### TypeScript 示例
+
+```typescript
+// 检测推送声音状态
+const isPushSoundEnabled: boolean = mixPublicLib.IsOpenPushSound();
+console.log(`推送声音状态: ${isPushSoundEnabled ? "已开启" : "未开启"}`);
+
+// 类型安全的状态处理
+if (isPushSoundEnabled) {
+  console.log("可以依赖声音提醒");
+} else {
+  console.log("需要其他提醒方式");
+}
+```
+
+## 使用说明
+
+### 返回值说明
+
+- **true**: 用户已开启推送通知的声音提醒
+- **false**: 用户关闭了推送声音，或设备处于静音模式，或不支持声音提醒
+
+### 平台差异
+
+- **iOS**: 检测系统通知设置中的声音选项
+- **Android**: 检测通知渠道的声音设置
+- **Web端**: 通常返回false（不支持推送声音检测）
+
+### 使用场景
+
+- 应用设置页面的推送声音状态显示
+- 决定是否使用声音作为主要提醒方式
+- 提供替代提醒方案（如震动、LED闪烁）
+- 用户体验优化（避免在静音时重复提醒）
+- 推送策略的动态调整
+
+## 注意事项
+
+- **平台限制**: 
+  - Web端通常无法检测推送声音状态
+  - 老版本操作系统可能不支持此检测
+  - 某些设备可能有自定义的通知设置
+- **系统状态影响**: 
+  - 设备静音模式会影响返回结果
+  - 勿扰模式可能导致返回false
+  - 音量设置为0可能被视为关闭声音
+- **用户体验**: 
+  - 提供清晰的声音状态说明
+  - 在声音关闭时提供替代提醒选项
+  - 引导用户在系统设置中调整通知声音
+- **最佳实践**: 
+  - 结合 `GetApnsAuthorizationStatus` 使用
+  - 提供完整的推送设置管理界面
+  - 测试不同系统状态下的检测结果
+  - 考虑用户的使用环境和偏好
+- **兼容性**: 
+  - 不同Android版本的通知渠道实现可能不同
+  - iOS的通知设置界面在不同版本中有差异
+  - 某些设备厂商可能有自定义的通知管理
+
+## 相关 API
+
+- [`GetApnsAuthorizationStatus`](./064-GetApnsAuthorizationStatus.md) - 获取推送授权状态
+- [`SettingApns`](./068-SettingApns.md) - 推送设置
+- [`BindCloudChannel`](./079-BindCloudChannel.md) - 绑定云通道

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/079-BindCloudChannel.md

@@ -0,0 +1,137 @@
+---
+date: 2026-03-06
+permalink: /pages/api-bind-cloud-channel/
+categories: 
+  - API
+  - 推送通知
+tags: []
+author: { name: AI Assistant }
+---
+
+# BindCloudChannel - 绑定云通道
+
+## 功能描述
+
+绑定设备到云推送通道。用于注册设备以接收云端推送消息。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+BindCloudChannel({ 
+  Account: string 
+  }): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Account | string | 是 | 绑定账号(项目唯一) | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 绑定云通道
+mixPublicLib.BindCloudChannel({ Account: "1234567890" });
+
+// 在应用启动时绑定云通道
+document.addEventListener('DOMContentLoaded', () => {
+  mixPublicLib.BindCloudChannel({ Account: "1234567890" });
+});
+
+// 结合推送权限检查使用
+const authStatus = mixPublicLib.GetApnsAuthorizationStatus();
+if (authStatus === 1) {
+  mixPublicLib.BindCloudChannel({ Account: "1234567890" });
+  console.log("云通道绑定成功");
+} else {
+  console.log("请先开启推送权限");
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 绑定云通道
+mixPublicLib.BindCloudChannel({ Account: "1234567890" });
+
+// 带错误处理的绑定操作
+try {
+  mixPublicLib.BindCloudChannel({ Account: "1234567890" });
+  console.log("云通道绑定成功");
+} catch (error) {
+  console.error("云通道绑定失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 注册设备到云端推送服务
+- 获取设备的推送令牌（token）
+- 建立与推送服务器的连接通道
+- 使设备能够接收远程推送消息
+
+### 平台差异
+
+- **iOS**: 绑定APNs（Apple Push Notification service）
+- **Android**: 绑定FCM（Firebase Cloud Messaging）或其他推送服务
+- **Web端**: 可能不支持或提供模拟功能
+
+### 绑定流程
+
+1. 检查推送权限状态
+2. 向系统请求推送权限（如果未授权）
+3. 获取设备的推送令牌
+4. 将令牌发送到云端服务器
+5. 建立推送通道连接
+
+### 使用场景
+
+- 应用启动时的推送初始化
+- 用户登录后的设备绑定
+- 推送权限开启后的通道绑定
+- 设备更换后的重新绑定
+- 推送功能恢复时的重新绑定
+
+## 注意事项
+
+- **权限依赖**: 
+  - 必须先获得推送权限授权
+  - 需要网络连接才能完成绑定
+  - 某些网络环境可能阻止推送连接
+- **平台限制**: 
+  - Web端通常不支持原生推送通道
+  - 老版本操作系统可能有兼容性问题
+  - 某些地区可能限制推送服务
+- **用户体验**: 
+  - 绑定过程通常是后台进行的
+  - 用户可能看到系统推送权限请求
+  - 绑定成功后用户可以接收推送消息
+- **最佳实践**: 
+  - 在应用启动时自动绑定
+  - 结合 `GetApnsAuthorizationStatus` 使用
+  - 提供手动重新绑定的选项
+  - 处理绑定失败的降级方案
+- **安全性**: 
+  - 推送令牌应该安全传输和存储
+  - 避免在客户端暴露敏感的推送信息
+  - 遵守相关的隐私和安全规范
+
+## 相关 API
+
+- [`UnbindCloudChannel`](./080-UnbindCloudChannel.md) - 解绑云通道
+- [`GetApnsAuthorizationStatus`](./064-GetApnsAuthorizationStatus.md) - 获取推送授权状态
+- [`SettingApns`](./068-SettingApns.md) - 推送设置
+- [`IsOpenPushSound`](./078-IsOpenPushSound.md) - 是否开启推送声音