08 房间模块

miot/service/Room

家庭房间管理是指对米家APP中“米家 tab”页面的房间进行管理，主要包括房间信息的获取、增加和修改。 开发者需要注意的是由于该系列API会影响到米家APP的用户体验，因此做了权限的控制， 如果开发者有使用该系列API的需求， 需要与SDK开发人员进行沟通获取权限。 对于家庭房间管理模块，目前我们提供能力主要在于信息的获取、增加和修改，细分具体如下: 1、获取所有房间列表信息 2、创建（新增）房间 3、修改房间名称

Export: public
Doc_name: 房间模块
Doc_index: 8
Doc_directory: service
Example

import { Service } from "miot";
Service.room.loadAllRoom(true).then((rooms)=>{
  console.log(rooms)
}).catch((error)=>{
 console.log(error)
})

• miot/service/Room
  • static
    • .IMHRoom
      • .homeID
      • .roomID
      • .name
      • .shareFlag
      • .didList
      • .updateName(newName) ⇒ [ 'Promise' ].<unknown>
  • inner
    • ~IMiotRoom
      • .loadAllRoom([forceReload]) ⇒ [ 'Rromise' ].<Array.<IMHRoom>>
      • .createRoom(name) ⇒ [ 'Rromise' ].<IMHRoom>

---

miot/service/Room.IMHRoom

Kind: static interface of miot/service/Room

• .IMHRoom
  • .homeID
  • .roomID
  • .name
  • .shareFlag
  • .didList
  • .updateName(newName) ⇒ [ 'Promise' ].<unknown>

---

imhRoom.homeID

房间所属的家庭ID

Kind: instance property of IMHRoom

---

imhRoom.roomID

房间ID

Kind: instance property of IMHRoom

---

imhRoom.name

房间名称

Kind: instance property of IMHRoom

---

imhRoom.shareFlag

房间的分享标识

Kind: instance property of IMHRoom

---

imhRoom.didList

房间支持的设备did列表，目前只有小爱音箱有权限

Kind: instance property of IMHRoom

---

imhRoom.updateName(newName) ⇒ [ 'Promise' ].<unknown>

更新房间名称

Kind: instance method of IMHRoom
Returns: [ 'Promise' ].<unknown> - 成功时：{"code":0, "data":'update success'} 失败时：{"code":xxx, "message":"xxx" }
Since: 10020

Param	Description
newName	新的房间名称

---

miot/service/Room~IMiotRoom

Kind: inner class of miot/service/Room
Export:

• ~IMiotRoom
  • .loadAllRoom([forceReload]) ⇒ [ 'Rromise' ].<Array.<IMHRoom>>
  • .createRoom(name) ⇒ [ 'Rromise' ].<IMHRoom>

---

iMiotRoom.loadAllRoom([forceReload]) ⇒ [ 'Rromise' ].<Array.<IMHRoom>>

获取当前家庭所有房间列表

Kind: instance method of IMiotRoom
Returns: [ 'Rromise' ].<Array.<IMHRoom>> - Promise, 带有房间列表的结果, IMHRoom的数据结构参考IMHRoom类 成功时：[{IMHRoom},...] 失败时：{"code":xxx, "message":"xxx" }
Since: 10020

Param	Type	Default	Description
[forceReload]	boolean	false	是否从强制从网络获取； false:表示从缓存获取 true：从网络获取； 默认为false

---

iMiotRoom.createRoom(name) ⇒ [ 'Rromise' ].<IMHRoom>

使用指定名称创建房间

Kind: instance method of IMiotRoom
Returns: [ 'Rromise' ].<IMHRoom> - Promise, 带有房间结果, IMHRoom的数据结构参考IMHRoom类 成功时：{IMHRoom} 失败时：{"code":xxx, "message":"xxx" }
Since: 10020

Param	Type	Description
name	string	要创建的房间名

---