开发
服务市场
社区

系统信息

swan.getSystemInfo

基础库 1.10.8 版本开始支持。

解释:获取系统信息

百度APP中扫码体验:

方法参数:Object object

object参数说明

参数名 类型 必填 默认值 说明
success Function - 接口调用成功的回调
fail Function - 接口调用失败的回调函数
complete Function - 接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明

参数 说明 最低版本
brand 手机品牌 -
model 手机型号 -
pixelRatio 设备像素比 -
screenWidth 屏幕宽度 -
screenHeight 屏幕高度 -
windowWidth 可使用窗口宽度 -
windowHeight 可使用窗口高度 -
statusBarHeight 状态栏的高度 -
navigationBarHeight 导航栏的高度 3.0.17
language 宿主 App 设置的语言 -
version 宿主 App 版本号 -
system 操作系统版本 -
platform 客户端平台,如:ios。 -
fontSizeSetting 用户字体大小设置 -
SDKVersion 客户端基础库版本 -
host 宿主平台,如:baiduboxapp 。 3.30.2
cacheLocation 上一次缓存的位置信息 安卓端最低swanjs版本3.40.4;ios最低支持版本3.70.2
swanNativeVersion 宿主平台版本号 最低支持版本1.13.18
devicePixelRatio 屏幕密度 安卓最低支持swanjs版本3.0.39; ios最低支持版本3.0.39
albumAuthorized 允许宿主使用相册的开关(仅 iOS 有效) ios最低支持版本3.110.3
notificationAuthorized 允许宿主通知的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
notificationAlertAuthorized 允许宿主通知带有提醒的开关(仅 iOS 有效) ios最低支持版本3.110.3
notificationBadgeAuthorized 允许宿主通知带有标记的开关(仅 iOS 有效) ios最低支持版本3.110.3
notificationSoundAuthorized 允许宿主通知带有声音的开关(仅 iOS 有效) ios最低支持版本3.110.3
cameraAuthorized 允许宿主使用摄像头的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
locationAuthorized 允许宿主使用定位的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
microphoneAuthorized 允许宿主使用麦克风的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
locationEnabled 地理位置的系统开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
wifiEnabled Wi-Fi 的系统开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
safeArea 在竖屏正方向下的安全区域 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3

示例
在开发者工具中预览效果

  • 在 js 文件中
1
2
3
4
5
6
7
8
swan.getSystemInfo({
success: res => {
console.log('getSystemInfo success', res)
},
fail: err => {
console.log('getSystemInfo fail', err)
}
});

错误码

Andriod

错误码 说明
201 解析失败,请检查调起协议是否合法
202 解析失败,请检查参数是否正确
402 安全性检查:访问控制校验失败

swan.getSystemInfoSync

解释:获取系统信息同步接口

方法参数:无

同步返回参数说明

参数 说明 最低版本
brand 手机品牌 -
model 手机型号 -
pixelRatio 设备像素比 -
screenWidth 屏幕宽度 -
screenHeight 屏幕高度 -
windowWidth 可使用窗口宽度 -
windowHeight 可使用窗口高度 -
statusBarHeight 状态栏的高度 -
navigationBarHeight 导航栏的高度 3.0.17
language 宿主 App 设置的语言 -
version 宿主 App 版本号 -
system 操作系统版本 -
platform 客户端平台,如:ios。 -
fontSizeSetting 用户字体大小设置 -
SDKVersion 客户端基础库版本 -
host 宿主平台,如:baiduboxapp 。 3.30.2
cacheLocation 上一次缓存的位置信息 安卓端最低swanjs版本3.40.4;ios最低支持版本3.70.2
swanNativeVersion 宿主平台版本号 最低支持版本1.13.18
devicePixelRatio 屏幕密度 安卓最低支持swanjs版本3.0.39; ios最低支持版本3.0.39
albumAuthorized 允许宿主使用相册的开关(仅 iOS 有效) ios最低支持版本3.110.3
notificationAuthorized 允许宿主通知的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
notificationAlertAuthorized 允许宿主通知带有提醒的开关(仅 iOS 有效) ios最低支持版本3.110.3
notificationBadgeAuthorized 允许宿主通知带有标记的开关(仅 iOS 有效) ios最低支持版本3.110.3
notificationSoundAuthorized 允许宿主通知带有声音的开关(仅 iOS 有效) ios最低支持版本3.110.3
cameraAuthorized 允许宿主使用摄像头的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
locationAuthorized 允许宿主使用定位的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
microphoneAuthorized 允许宿主使用麦克风的开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
locationEnabled 地理位置的系统开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
wifiEnabled Wi-Fi 的系统开关 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3
safeArea 在竖屏正方向下的安全区域 安卓最低支持swanjs版本3.110.3; ios最低支持版本3.110.3

示例

在开发者工具中预览效果

  • 在 js 文件中
1
2
3
4
5
6
try {
const result = swan.getSystemInfoSync();
console.log('getSystemInfoSync success', result);
} catch (e) {
console.log('getSystemInfoSync fail', e);
}

错误码

Andriod

错误码 说明
202 解析失败,请检查参数是否正确

swan.getEnvInfoSync

基础库 2.0.28 版本开始支持。

解释:获取运行环境信息同步接口

方法参数:无

同步返回参数说明

参数 类型 说明
appKey string 智能小程序 App Key
appName string 智能小程序名称
lastAppURL string 智能小程序最近一次打开的调起协议
sdkVersion string 基础库版本
scheme string 调起协议的协议头
env string 智能小程序的版本(基础库 3.90.12 开始支持);development 代表开发版本,trial 代表体验版本,production 代表线上版本

示例

在开发者工具中预览效果

  • 在 js 文件中
1
2
3
4
5
6
try {
const result = swan.getEnvInfoSync();
console.log('getEnvInfoSync success', result);
} catch (e) {
console.log('getEnvInfoSync fail', e);
}

swan.canIUse

解释: 判断智能小程序的API,回调,参数,组件等是否在当前版本可用。暂无法校验宿主扩展的API。

方法参数: String schema

使用 ${API}.${method}.${param}.${options}或者 ${component}.${attribute}.${option} 方式来调用。

schema参数说明

参数 说明
${API} API 名字
${method} 调用方式,有效值为return, success, object, callback
${param} 参数或者返回值
${options} 参数的可选值
${component} 组件名字
${attribute} 组件属性
${option} 组件属性的可选值

示例

在开发者工具中预览效果

  • 在 js 文件中
1
2
3
4
5
6
7
8
9
10
11
12
13
Page({
canIUse() {
console.log('canIUse:view.hover-class', swan.canIUse('view.hover-class'));
console.log('canIUse:scroll-view.scroll-x', swan.canIUse('scroll-view.scroll-x'));
console.log('canIUse:cover-view', swan.canIUse('cover-view'));
console.log('canIUse:button.size.default', swan.canIUse('view.button.size.default'));
console.log('canIUse:request.object.success.data', swan.canIUse('request.object.success.data'));
console.log('canIUse:getSavedFileList', swan.canIUse('getSavedFileList'));
console.log('canIUse:getSavedFileList.object', swan.canIUse('getSavedFileList.object'));
console.log('canIUse:getSavedFileList.object.success', swan.canIUse('getSavedFileList.object.success'));
console.log('canIUse:sjs', swan.canIUse('sjs'));
}
});
编 辑文 档 反 馈帮 助 回 到顶 部