设备
判断接口是否可以在当前客户端版本运行
使用说明
canIUse 方法调用的参数使用 api 名称
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
const result = window.ksoxz_sdk.canIUse('authorize')返回结果
| 参数 | 说明 |
|---|---|
| boolean | 客户端是否支持此 api |
获取设备信息
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
window.ksoxz_sdk.getDeviceInfo({onSuccess(deviceInfo)});返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| pixelRatio | number | 设备像素比 | |
| screenWidth | number | 屏幕宽度 | 分辨率 |
| screenHeight | number | 屏幕高度 | 分辨率 |
| model | string | 型号 | / |
| version | string | 设备系统版本 | / |
| netInfo | string | 网络类型 | wifi，ethernet，2g, 3g, 4g, 5g, unknown, none |
| operatorType | string | 运营商信息 | CMCC：中国移动 WCDMA：中国联通 CDMA：中国电信 unknown：未知 |
| platform | string | 客户端平台 | iOS, android, PC |
| displayMode | string | 协作在当前屏幕尺寸下的显示模式 | PhoneMode：手机显示模式 TabletMode：平板显示模式 |
| deviceId | string | 设备识别标识 | 设备id |
获取客户端信息
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
window.ksoxz_sdk.getAppInfo({onSuccess});返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| platform | string | 客户端平台： iOS，Android，Windows，macOS | / |
| version | string | 客户端版本号 | / |
| packageName | string | 客户端包名 | / |
| showOpenUrlModal | boolean | 客户端打开外部链接是否弹窗提示 | / |
| channel | string | 渠道号 | / |
| sdkVersion | string | 客户端woasdk包版本号 | / |
| appSettingInfo | object | / | / |
| ∟ fontSizeLevel | string | 字体大小 | PC端：0为标准，1-3逐步增大 移动端：0为缩小，1为标准，0-4逐步增大 |
| ∟ isDarkMode | boolean | 是否开启深色模式 | true为开启，false为跟随系统/浅色模式 |
获取授权的接口
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
window.ksoxz_sdk.authorize({params: { scope: 'album'}, onSuccess, onError});说明参数
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| scope | string | / | camera: 摄像头 microphone: 麦克风 album: 相册 access-storage: 内置存储读取、写入 location: 定位 |
返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| auth | boolean | 是否授权成功 | / |
| code | string | 错误编码 | / |
| msg | string | 错误信息 | / |
获取网络类型
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
window.ksoxz_sdk.getNetworkType({onSuccess});//用于获取设备当前网络状态返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| status | string | 是否授权成功 | wifi、ethernet（以太网）、2g、3g、4g、5g、unknown（如果设备无法确定上述网络类型，则会返回该值）、none（无网络/离线）、connected：已连接网络（仅PC端设备返回该值） PC端设备仅会返回2个类型，包括 none和connected |
网络质量评级
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | / | 支持 | 支持 |
window.ksoxz_sdk.getNetworkQualityType({onSuccess});//用于对已获取设备网络进行评级是否网络良好返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| networkQualityType | string | 网络质量评级类型 | unavailable：无网络 weak：弱网络 moderate：中等网络 excellent：良好网络 unknown：如果设备无法确定网络分级，则会返回该值 PC端设备仅会返回2个类型，包括 none和connected |
监听网络质量变化
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | / | 支持 | 支持 |
window.ksoxz_sdk.setNetworkQualityChange({onChange(res)=>{
console.log(res.networkQualityType);
});//设置网络质量监听返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| networkQualityType | string | 网络质量评级类型 | unavailable：无网络 weak：弱网络 moderate：中等网络 excellent：良好网络 unknown：如果设备无法确定网络分级，则会返回该值 PC端设备仅会返回2个类型，包括 none和connected |
取消监听网络质量变化
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | / | 支持 | 支持 |
window.ksoxz_sdk.removeNetworkQualityChange();