授權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
}

?👉 立即開發。