表盘管理 watchface
接口声明
{ "name": "system.watchface" }
导入模块
import watchface from '@system.watchface' 或 const watchface = require('@system.watchface')
接口定义
watchface.install(OBJECT)
安装表盘
OBJECT 参数:
参数名 |
类型 |
必填 |
说明 |
path |
String |
是 |
指定安装的表盘文件路径 |
success |
Function |
否 |
成功返回的回调函数 |
fail |
Function |
否 |
失败的回调函数,可能会因为权限失败 |
complete |
Function |
否 |
结束的回调函数(调用成功、失败都会执行) |
示例:
watchface.install({
path: '/watchfaces/com.vivo.watch.demo',
success: function () {
console.log(`handling sucess`)
},
fail: function (data, code) {
console.log(`handling fail, code = ${code}, errorMsg=${data}`)
},
})
watchface.uninstall(OBJECT)
卸载表盘
OBJECT 参数:
参数名 |
类型 |
必填 |
说明 |
package |
String |
是 |
指定卸载的表盘包名 |
success |
Function |
否 |
成功返回的回调函数 |
fail |
Function |
否 |
失败的回调函数,可能会因为权限失败 |
complete |
Function |
否 |
结束的回调函数(调用成功、失败都会执行) |
示例:
watchface.uninstall({
package: 'com.vivo.watch.demo',
success: function () {
console.log(`handling sucess`)
},
fail: function (data, code) {
console.log(`handling fail, code = ${code}, errorMsg=${data}`)
},
})
watchface.getInstalledWatchFaces(OBJECT)
获取已安装表盘列表
OBJECT 参数:
参数名 |
类型 |
必填 |
说明 |
success |
Function |
否 |
成功返回的回调函数 |
fail |
Function |
否 |
失败的回调函数,可能会因为权限失败 |
complete |
Function |
否 |
结束的回调函数(调用成功、失败都会执行) |
success 返回值 data
参数名 |
类型 |
说明 |
watchfaces |
Object[] |
已安装的表盘信息 watchface 列表 |
watchface 返回值:
参数名 |
类型 |
说明 |
id |
String |
表盘 id,根据包名哈希生成 |
name |
String |
表盘名称 |
package |
String |
表盘包名 |
path |
String |
表盘页面路径 |
edit |
String |
为空字符串 '' 时,表盘为不可编辑表盘;为非空字符串值时,代表编辑表盘页面的路径 |
previewImage |
String |
预览图路径 |
示例:
watchface.getInstalledWatchFaces({
success: function (data) {
data.watchfaces.forEach((watchface) => {
console.log(JSON.stringify(watchface))
})
},
fail: function (data, code) {
console.log(`handling fail, code = ${code}, errorMsg=${data}`)
},
})