【小程序】应用程序编程接口汇总——授权API、OTA API、家庭API

授权API

ty.authorize

权限请求方法

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
scope string scope 权限名称 举例子: scope.bluetooth 蓝牙权限 scope.writePhotosAlbum 写入相册权限 scope.userLocationBackground 后台定位权限 scope.record 麦克风权限 scope.camera 摄像头权限 scope.userLocation 低精度定位权限 scope.userPreciseLocation 高精度定位权限
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

函数定义示例

复制代码
/**
 * 权限请求方法
 */
export function authorize(params: {
  /**
   * scope 权限名称
   * 举例子:
   * scope.bluetooth 蓝牙权限
   * scope.writePhotosAlbum 写入相册权限
   * scope.userLocationBackground 后台定位权限
   * scope.record 麦克风权限
   * scope.camera 摄像头权限
   * scope.userLocation 低精度定位权限
   * scope.userPreciseLocation 高精度定位权限
   */
  scope: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.authorizeStatus

查询权限状态

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
scope string scope 权限名称 举例子: scope.bluetooth 蓝牙权限 scope.writePhotosAlbum 写入相册权限 scope.userLocationBackground 后台定位权限 scope.record 麦克风权限 scope.camera 摄像头权限 scope.userLocation 低精度定位权限 scope.userPreciseLocation 高精度定位权限
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

函数定义示例

复制代码
/**
 * 查询权限状态
 */
export function authorizeStatus(params: {
  /**
   * scope 权限名称
   * 举例子:
   * scope.bluetooth 蓝牙权限
   * scope.writePhotosAlbum 写入相册权限
   * scope.userLocationBackground 后台定位权限
   * scope.record 麦克风权限
   * scope.camera 摄像头权限
   * scope.userLocation 低精度定位权限
   * scope.userPreciseLocation 高精度定位权限
   */
  scope: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即开发

OTA API

ty.device.checkOTAUpdateInfo

检查固件升级信息

需引入DeviceKit,且在>=1.2.6版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
deviceId string deviceId 设备 id
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

ty.device.checkOTAUpgradeStatus

获取设备的固件版本状态

需引入DeviceKit,且在>=2.2.0版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
deviceId string deviceId 设备 id
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性 类型 说明
status number status 设备的固件版本状态 0 已是最新版本、1 有待升级的固件、2 正在升级

object.fail 回调参数

参数

Object res

属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.openOTAUpgrade

跳转设备升级页面

需引入DeviceKit,且在>=2.2.0版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
deviceId string deviceId 设备 id
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

👉 立即开发

家庭API

ty.home.getCurrentHomeInfo

获取当前家庭信息

需引入HomeKit,且在>=3.0.1版本才可使用

请求参数

Object object

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

返回结果

  • success
属性 类型 说明
homeName string 家庭名称
homeId string 家庭 id
longitude string 经度
latitude string 维度
address string 详细地址
admin boolean 是否是管理员 true 是管理员; false 非管理员
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码
ty.home.getCurrentHomeInfo({
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码
{
  "homeId": "26725023",
  "admin": true,
  "latitude": "30.30039978027344",
  "longitude": "120.0689010620117",
  "homeName": "我的家庭",
  "address": "华策中心A座"
}

ty.home.getDeviceIdList

获取当前维度下的设备 id 列表

需引入HomeKit,且在>=3.1.0版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
ownerId number 维度 id(比如家庭id)
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
devIds Array<String> 设备 id 列表
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码
ty.home.getDeviceIdList({
  ownerId: '26725023',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码
{
  "devIds": [
    "vdevo168845027498793", 
    "64710761ecfabcaaf553", 
    "6c87332fc414a65029ovfr"
  ]
}

ty.home.getRoomList

从 sdk 本地缓存中获取当前家庭维度下房间的设备 id 列表

需引入HomeKit,且在>=3.1.0版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
ownerId number 维度 id(比如家庭 id)
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
roomDatas Array<RoomInfo> 房间列表

RoomInfo

属性 类型 说明
name String 房间名称
roomId number 房间 id
deviceIds Array<String> 设备 id 列表
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码
ty.home.getRoomList({
  ownerId: '26725023',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码
{
  "roomDatas": [{
    "name": "Living room",
    "deviceIds": ["vdevo160395678273817"],
    "roomId": 18585095
  }, {
    "name": "Master bedroom",
    "deviceIds": ["64710761ecfabcaaf553"],
    "roomId": 18585096
  }, {
    "name": "Second bedroom",
    "deviceIds": [],
    "roomId": 18585097
  }]
}

ty.home.getDeviceRoomInfo

获取设备房间信息

需引入HomeKit,且在>=3.0.1版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
deviceId string 设备 id
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
roomId number The room ID.
name string The room name.
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码
ty.home.getDeviceRoomInfo({
  deviceId: '64710761ecfabcaaf553',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码
{
  "name": "Living room",
  "roomId": 18585096
}

👉 立即开发

相关推荐
百思可瑞教育6 分钟前
在Vue项目中Axios发起请求时的小知识
前端·javascript·vue.js·北京百思教育
dpxiaolong12 分钟前
RK3588 Android12默认移除导航栏
开发语言·python
患得患失94920 分钟前
【个人项目】【前端实用工具】OpenAPI to TypeScript 转换器
前端·javascript·typescript
大前端helloworld27 分钟前
前端梳理体系从常问问题去完善-基础篇(html,css,js,ts)
前端·javascript·面试
trsoliu39 分钟前
前端基于 TypeScript 使用 Mastra 来开发一个 AI 应用 / AI 代理(Agent)
前端·人工智能
Pocker_Spades_A42 分钟前
Python快速入门专业版(二十九):函数返回值:多返回值、None与函数嵌套调用
服务器·开发语言·python
鸡吃丸子43 分钟前
前端权限控制:深入理解与实现RBAC模型
前端
Larry_zhang双栖44 分钟前
低版本Chrome 内核兼容性问题的优美解决
前端·chrome
良木林1 小时前
浅谈原型。
开发语言·javascript·原型模式
烈风1 小时前
004 Rust控制台打印输出
开发语言·后端·rust