07 页面导航模块 - MiEcosystem/miot-plugin-sdk GitHub Wiki

本地原生业务页面访问与处理

Export: public
Doc_name: 页面导航模块
Doc_index: 7
Doc_directory: host
Example

import {Host} from 'miot'
...
//删除设备
Host.ui.openDeleteDevice()
//分享设备
Host.ui.openShareDevicePage

• miot/host/ui
  • ~IUi
    • .canOpenStorePage() ⇒ [ 'Promise' ].<Boolean>
    • .checkStoreSupporttedOnAndroid() ⇒ boolean
    • .openDeleteDevice([title])
    • .openDeleteDeviceWithCallback()
    • .openShareDevicePage()
    • .keepScreenNotLock(flag)
    • .openRoomManagementPage()
    • .openVoiceCtrlDeviceAuthPage()
    • .openIftttAutoPage()
    • .openFeedbackInput()
    • .openSecuritySetting()
    • .openHelpPage()
    • .openShareListBar(title, description, imagePath, url)
    • .openSystemShareWindow(pathOrUrl)
    • .openSystemFileWindow(pathOrUrl)
    • .getDevicesWithModel(model, includeGroupedDevice) ⇒ [ 'Promise' ].<Array.<devices>>
    • .openBtGatewayPage()
    • .alertLegalInformationAuthorization(option) ⇒ [ 'Promise' ].<Boolean>
    • .previewLegalInformationAuthorization(option) ⇒ [ 'Promise' ].<Boolean>
    • .privacyAndProtocolReview(licenseTitle, licenseUrl, policyTitle, policyUrl)
    • .openPrivacyLicense(licenseTitle, licenseUrl, policyTitle, policyUrl) ⇒ [ 'Promise' ].<Boolean>
    • .openChangeDeviceName()
    • .openAddToDesktopPage()
    • .openDeviceUpgradePage(type)
    • .openDeviceUpgradeHistoryPage()
    • .openBleMeshDeviceUpgradePage()
    • .openBleCommonDeviceUpgradePage(params)
    • .openLightGroupUpgradePage()
    • .openBleGroupUpgradePage(type)
    • .openDeviceTimeZoneSettingPage({"sync_device":)
    • .openWebPage(url, params)
    • .openShopPage(gid)
    • .openShopSearchPage(keyword)
    • .openProductBaikeWebPage(url)
    • .openMeshDeviceGroupPage(type, did, version)
    • .openAddDeviceGroupPage(groupModel)
    • .openEditDeviceGroupPage(dids)
    • .openCountDownPage(isCountDownOn, setting)
    • .openOneTimePassword(did, interval, digits)
    • .openTimerSettingPage(onMethod, onParam, offMethod, offParam)
    • .openTimerSettingPageWithCustomIdentifier(customTimerIdentifier, onMethod, onParam, offMethod, offParam)
    • .openTimerSettingPageWithVariousTypeParams(onMethod, onParam, offMethod, offParam)
    • .openTimerSettingPageWithOptions(options)
    • .openPowerMultikeyPage(did, mac)
    • .addOrCopyIR(did, type, models, extra)
    • .openDevice(did, model, params) ⇒ [ 'Promise' ].<json>
    • .openPluginPage(did, pageName, pageParams)
    • .openPageWithClassName(className)
    • .openNewMorePage()
    • .openPhoneBluSettingPage()
    • .openXiaoAiLearnPage(clientId, did, aiMiotClientId, aiClientId, aiVersion, otherParams)
    • .showBLESwitchGuide()
    • .dismissBLESwitchGuide()
    • .openConnectSucceedPage(model, did)
    • .openCurtainGroupNamePage(groupDid, leftDid, rightDid)
    • .openZigbeeConnectDeviceList(did)
    • .openDeviceNetworkInfoPage()
    • .openMiPayPageForAndroid(params) ⇒ [ 'Promise' ].<object>
    • .openPluginRecommendScene(did, recommendId)
    • .refreshDeviceList() ⇒ Promise
    • .openTerminalDeviceSettingPage(type)
    • .openAndroidLocationServerSettingPage()
    • .openResetAndConnectDevicePage()
    • .openVoiceCtrlDevListPage()
    • .openStereoSettingPage()
    • .openXiaoaiContentPage()
    • .openClockMusicSelector(ringtone_tab, ringtone_id, ringtone_name, ringtone_query)
    • .openEarthquakeLocationSelector(name, district, city, latitude, longitude)
    • .openIOSDocumentFileChoosePage() ⇒ Promise
    • .openNFCWriteDeviceInfoPage(extra)
    • .openNFCWriteDeviceInfoDebugPage(params)
    • .openCommonDeviceSettingPage(type)
    • .getFreqCameraNeedShowRedPoint() ⇒ object
    • .clearFreqCameraNeedShowRedPoint()
    • .openGenerateCrontabStringPage()
    • .openFirmWareAutoOTAPage()

Kind: inner interface of miot/host/ui

• ~IUi
  • .canOpenStorePage() ⇒ [ 'Promise' ].<Boolean>
  • .checkStoreSupporttedOnAndroid() ⇒ boolean
  • .openDeleteDevice([title])
  • .openDeleteDeviceWithCallback()
  • .openShareDevicePage()
  • .keepScreenNotLock(flag)
  • .openRoomManagementPage()
  • .openVoiceCtrlDeviceAuthPage()
  • .openIftttAutoPage()
  • .openFeedbackInput()
  • .openSecuritySetting()
  • .openHelpPage()
  • .openShareListBar(title, description, imagePath, url)
  • .openSystemShareWindow(pathOrUrl)
  • .openSystemFileWindow(pathOrUrl)
  • .getDevicesWithModel(model, includeGroupedDevice) ⇒ [ 'Promise' ].<Array.<devices>>
  • .openBtGatewayPage()
  • .alertLegalInformationAuthorization(option) ⇒ [ 'Promise' ].<Boolean>
  • .previewLegalInformationAuthorization(option) ⇒ [ 'Promise' ].<Boolean>
  • .privacyAndProtocolReview(licenseTitle, licenseUrl, policyTitle, policyUrl)
  • .openPrivacyLicense(licenseTitle, licenseUrl, policyTitle, policyUrl) ⇒ [ 'Promise' ].<Boolean>
  • .openChangeDeviceName()
  • .openAddToDesktopPage()
  • .openDeviceUpgradePage(type)
  • .openDeviceUpgradeHistoryPage()
  • .openBleMeshDeviceUpgradePage()
  • .openBleCommonDeviceUpgradePage(params)
  • .openLightGroupUpgradePage()
  • .openBleGroupUpgradePage(type)
  • .openDeviceTimeZoneSettingPage({"sync_device":)
  • .openWebPage(url, params)
  • .openShopPage(gid)
  • .openShopSearchPage(keyword)
  • .openProductBaikeWebPage(url)
  • .openMeshDeviceGroupPage(type, did, version)
  • .openAddDeviceGroupPage(groupModel)
  • .openEditDeviceGroupPage(dids)
  • .openCountDownPage(isCountDownOn, setting)
  • .openOneTimePassword(did, interval, digits)
  • .openTimerSettingPage(onMethod, onParam, offMethod, offParam)
  • .openTimerSettingPageWithCustomIdentifier(customTimerIdentifier, onMethod, onParam, offMethod, offParam)
  • .openTimerSettingPageWithVariousTypeParams(onMethod, onParam, offMethod, offParam)
  • .openTimerSettingPageWithOptions(options)
  • .openPowerMultikeyPage(did, mac)
  • .addOrCopyIR(did, type, models, extra)
  • .openDevice(did, model, params) ⇒ [ 'Promise' ].<json>
  • .openPluginPage(did, pageName, pageParams)
  • .openPageWithClassName(className)
  • .openNewMorePage()
  • .openPhoneBluSettingPage()
  • .openXiaoAiLearnPage(clientId, did, aiMiotClientId, aiClientId, aiVersion, otherParams)
  • .showBLESwitchGuide()
  • .dismissBLESwitchGuide()
  • .openConnectSucceedPage(model, did)
  • .openCurtainGroupNamePage(groupDid, leftDid, rightDid)
  • .openZigbeeConnectDeviceList(did)
  • .openDeviceNetworkInfoPage()
  • .openMiPayPageForAndroid(params) ⇒ [ 'Promise' ].<object>
  • .openPluginRecommendScene(did, recommendId)
  • .refreshDeviceList() ⇒ Promise
  • .openTerminalDeviceSettingPage(type)
  • .openAndroidLocationServerSettingPage()
  • .openResetAndConnectDevicePage()
  • .openVoiceCtrlDevListPage()
  • .openStereoSettingPage()
  • .openXiaoaiContentPage()
  • .openClockMusicSelector(ringtone_tab, ringtone_id, ringtone_name, ringtone_query)
  • .openEarthquakeLocationSelector(name, district, city, latitude, longitude)
  • .openIOSDocumentFileChoosePage() ⇒ Promise
  • .openNFCWriteDeviceInfoPage(extra)
  • .openNFCWriteDeviceInfoDebugPage(params)
  • .openCommonDeviceSettingPage(type)
  • .getFreqCameraNeedShowRedPoint() ⇒ object
  • .clearFreqCameraNeedShowRedPoint()
  • .openGenerateCrontabStringPage()
  • .openFirmWareAutoOTAPage()

是否支持商城

Kind: instance method of IUi
Example

Host.ui.canOpenStorePage().then(res => console("can open store = ", res))

Deprecated

检测Android是否支持集成了商城,目前是通过当前的服务来判断的

Kind: instance method of IUi

弹出删除设备的对话框

Kind: instance method of IUi

android 设备暂不支持该方法 会直接reject(false) 删除设备 注意：此方法只做删除设备的活，不会返回上一页。所以在then里面，需要自己调用closeCurrentPage

Kind: instance method of IUi

打开分享设备的页面

Kind: instance method of IUi

是否保持屏幕常亮

Kind: instance method of IUi

打开房间设备管理的页面

Kind: instance method of IUi

打开语音设备管理的页面

Kind: instance method of IUi

Deprecated

打开添加智能的页面,注意分享的用户无法打开

Kind: instance method of IUi

打开反馈页

Kind: instance method of IUi

打开安全管理页

Kind: instance method of IUi

打开常见问题页，别名「使用帮助」

Kind: instance method of IUi

打开分享列表页面

Kind: instance method of IUi

打开系统分享文件页面

Kind: instance method of IUi

打开系统文件打开页面 since 10050

Kind: instance method of IUi

获取设备列表中指定model的设备信息(仅白名单设备才允许调用此方法，如需使用，请联系插件框架)

Kind: instance method of IUi
Returns: [ 'Promise' ].<Array.<devices>> - 对象中有字段 isGrouped 表示是被分组的设备，includeGroupedDevice = true时才有效

打开蓝牙网关页

Kind: instance method of IUi

弹窗请求隐私政策和用户协议授权， 支持显示用户体验计划

Kind: instance method of IUi
Returns: [ 'Promise' ].<Boolean> - 弹窗授权结果
Since: 10023

Example

可以参考iot文档 或 project/com.xiaomi.demo/MainPage.js部分样例

查看隐私政策和用户协议信息， 支持显示用户体验计划

Kind: instance method of IUi
Returns: [ 'Promise' ].<Boolean> - 授权结果
Since: 10023

Deprecated

查看软件政策和隐私协议

Kind: instance method of IUi

Deprecated

软件政策和隐私协议授权 隐私协议弹框需求： a. 所有接入米家的设备，绑定成功后第一次进插件，都需要隐私弹框，后续再进不需弹框 b. 取消隐私授权/解绑设备后，重新绑定设备，仍需遵循规则a 插件端可按如下方案实现：

1. 使用batchSetDeviceDatas存储一个标志位，用来记录是否“隐私弹框”过
2. 进入插件时batchGetDeviceDatas获取此标志位，若为NO，弹框，同时设置标志位为YES；若为YES，不弹框
3. 设备取消授权或解绑设备时，此标志位米家后台会自动清除，故遵循了上述需求b
4. 异常处理：进插件时，如果网络异常等原因导致batchGetDeviceDatas失败，就不弹框（此时99%情况是第2+次进插件）

Kind: instance method of IUi

打开重命名对话框

Kind: instance method of IUi

添加桌面快捷方式

Kind: instance method of IUi

打开设备检查固件升级页（先检查，后可升级） 针对wifi、AP、第三方云等可以联网的设备的统一OTA方案

Kind: instance method of IUi

打开设备检查固件历史版本信息页面

Kind: instance method of IUi

打开Mesh设备固件升级页。分享的设备点击此接口无反应（理论上分享的设备不应该出现调用此接口的菜单）

Kind: instance method of IUi
Since: 10025 后续蓝牙统一OTA接口openBleCommonDeviceUpgradePage接口传参数param.auth_type = 5时也可以实现此功能（两种方式的原生实现一致），但为了向前兼容厂商已调用的此接口，所以此接口不能下掉

打开通用协议的蓝牙固件OTA页面。分享的设备点击此接口无反应（理论上分享的设备不应该出现调用此接口的菜单）

Kind: instance method of IUi
Since: 10038

Example

Host.ui.openBleCommonDeviceUpgradePage({auth_type: 5 })
目前ios在进行OTA前，可以先断开与设备的蓝牙连接，然后再从设备广播的信息中拿到设备auth_type的值（无需传参auth_type），但是安卓暂时不好实现所以接口增加了参数auth_type

打开灯组2.0固件升级页。分享的设备点击此接口无反应（理论上分享的设备不应该出现调用此接口的菜单）

Kind: instance method of IUi
Since: 10031

打开Ble 组设备升级页面

Kind: instance method of IUi
Since: 10049

打开设备时区设置页 apiLevel在10025，增加参数的支持，APP修改时区是否需要同步到设备端，前提是设备需要支持miIO.set_timezone 方法 如果sync_device为true，服务端会给设备发送rpc,例如： {'method':'miIO.set_timezone','params':["Asia/Chongqing"]}

Kind: instance method of IUi
Since: 10025

打开H5页面 不对外提供

Kind: instance method of IUi

打开商城某商品详情页面

Kind: instance method of IUi

打开商城搜索结果页面

Kind: instance method of IUi
Since: 10024

打开产品百科H5页面

Kind: instance method of IUi
Since: 10035

打开Mesh灯组 添加/编辑 页,Device.pid为17，则为Mesh设备组

Kind: instance method of IUi
Since: 10021

打开创建设备组页，如果是支持Mesh的设备，请使用上面的openMeshDeviceGroupPage

Kind: instance method of IUi

打开编辑设备组页，只有在设备组页内，需要修改设备组时，才能调用此方法。如果是设备页面内，请使用上面的openAddDeviceGroupPage方法

Kind: instance method of IUi

Deprecated

开启倒计时界面

Kind: instance method of IUi

Example

Host.ui.openCountDownPage(true, {onMethod:"power_on", offMethod:'power_off', onParam:'on', offParam:'off',displayName:"新名字"})

打开一次性密码设置页

Kind: instance method of IUi

Deprecated

这个api 应该可以废弃了，使用 Service.scene.openTimerSettingPageWithOptions()

Kind: instance method of IUi

Deprecated

这个api 应该可以废弃了，使用 Service.scene.openTimerSettingPageWithOptions()

Kind: instance method of IUi

Kind: instance method of IUi

Example

Host.ui.openTimerSettingPageWithVariousTypeParams("power_on", ["on", "title"], 'off',"title"}),

Deprecated

扩展自 openTimerSettingPageWithVariousTypeParams , 新增支持自定义name使用

Kind: instance method of IUi
Since: 10010 ,SDKLevel 10010 开始提供使用

Example

Host.ui.openTimerSettingPageWithOptions({onMethod:"power_on", onParam: "on", offMethod: "power_off", offParam: "off", displayName:"设置xxx定时"，identify:"plug_usb_countdowm"})

更多设置-多键开关设置页面

Kind: instance method of IUi
Since: 10010 ,SDKLevel 10010 开始提供使用

Example

Host.ui.openPowerMultikeyPage(did, mac);

添加或者复制一个红外遥控器

Kind: instance method of IUi
Since: 10003

打开用户账号下某一设备的插件

Kind: instance method of IUi
Returns: [ 'Promise' ].<json> - 打开插件失败，返回错误信息；打开插件成功，无回调信息

打开用户账号下某一设备的插件,可支持跳转到插件的某一页面 至于跳转到哪个页面，需要插件方做支持，示例可以参考com.xiaomi.demo 中 Host.ui.openPluginPage 的使用 整体流程如下： 插件调用此方法openPluginPage ⬇ ️ 将参数传到native ⬇ native调用打开插件的方法，带上此处传递的参数 ⬇ native打开RN页面，将参数传递到Package.js ⬇ 支持打开内部页面的插件，通过Package.entrance获取将要跳转到哪个页面，通过Package.pageParams获取此页面需要的页面参数 ⬇ 打开插件对应页面，注意：如果isBackToMainPage为true，则需要在你的插件首页的componentDidMount中，增加跳转逻辑，反之，则应该在index.js中控制入口界面。详细使用请参考Demo中 openPluginPage、Package.entrance、Package.pageParams三个方法的使用

Kind: instance method of IUi
Since: 10026

Example

let pageParams = {did:Device.deviceID,model:Device.model}
Host.ui.openPluginPage(Device.deviceID, PluginEntrance.Setting, pageParams)

打开一个原生类 className ，界面类类名 注意 用此方法打开的vc初始化时不需要传参数， 需要传参的viewController暂时还需要手动导出

Kind: instance method of IUi

Deprecated

Kind: instance method of IUi

Kind: instance method of IUi
Since: 10002 android特有页面，ios 不能使用 打开手机蓝牙设置页面

打开小爱训练计划

Kind: instance method of IUi

显示提示用户打开蓝牙的动画示意图, 仅在iOS下有效，Android下无反应

Kind: instance method of IUi
Since: 10004

隐藏提示用户打开蓝牙的动画示意图, 仅在iOS下有效，Android下无反应

Kind: instance method of IUi
Since: 10004

打开设备快连成功页面

Kind: instance method of IUi
Since: 10004

打开窗帘组选房间设置名称的页面

Kind: instance method of IUi
Since: 10049

打开Zigbee 网关插件开启子设备快连

Kind: instance method of IUi
Since: 10020

打开设备网络信息页面，米家已提供入口：设置 - 更多设置 - 网络信息。此方法只针对wifi设备，combo设备，蓝牙设备请不要调用此方法。

Kind: instance method of IUi
Since: 10026

android 特有， 跳转到小米钱包

Kind: instance method of IUi

Example

let params = {action:'issue_mifare',type:'1',product_id:'66666-00211',source_channel:'mijia'};
Host.ui.openMiPayPageForAndroid(params).then((res)=>{console.log(res)}).catch((error)=>{ console.log(error)});

跳转到设备定向推荐界面,注意：SDK_10024及其之后才可使用

Kind: instance method of IUi
Since: 10024

刷新设备列表，同时刷新设备列表页UI

Kind: instance method of IUi
Since: 10025

跳转到终端设备指定的设置页面 如 iPhone和安卓手机的系统设置页面

Kind: instance method of IUi
Since: 10036

打开Android系统位置信息设置页(不同于权限配置页) only Android

Kind: instance method of IUi
Since: 10038

打开设备重置页面

Kind: instance method of IUi
Since: 10041

打开语音授权页面

Kind: instance method of IUi
Since: 10041

打开立体声设置页面

Kind: instance method of IUi
Since: 10041

跳转到米家播放音乐页面

Kind: instance method of IUi

跳转到选择闹钟音乐页面，入参是为了告诉native当前选中的是哪个铃声，以高亮当前选中

Kind: instance method of IUi

跳转到地震播报选择地理位置页面，入参是为了告诉native当前选中的是哪个位置

Kind: instance method of IUi

打开文件选择页面 only for iOS 在使用前建议判断平台

Kind: instance method of IUi
Returns: Promise - 成功时返回 { code: 0 , data: [ { path: xxx, fileName: xxx, ext: xxx, fileSize: xxx}, {...}] } 其中 path 是文件的绝对地址，ext是扩展名，fileName是文件名，byteLen 是文件 size 单位是byte 需要特别说明的是： 1：data 返回的数组类型 在 10042 中目前仅返回一个文件信息，不支持多选 2：如果用户没有选择任何文件，例如点击了左上角的取消按钮，那么 data 中会返回空数组，开发人员需要对此做处理。 失败时返回 { code: -1, message: 'file authorized failed'} // 在ios中 获取icloud需要验证授权，此处错误代表授权失败，如果出现此错误，请联系米家开发人员或提交工单反馈。 { code: -2, message: 'file read error'} // 出现此种错误 代表 ios 获取授权文件路径失败，如果出现此错误，请联系米家开发人员或提交工单反馈。 { code: -3, message: 'method [openIOSDocumentFileChoosePage] can only be invoked on iOS, Android is not supported.' }
Since: 10042

Kind: instance method of IUi
Since: 10049 打开NFC写设备数据的页面，默认会写入设备的基本信息(如did，model等)，如果插件还需要写入其他数据，可以通过参数extra传给App； 在米家首页，手机接触到NFC设备时会读取写入的设备信息，读取成功后会自动打开相应的插件，插件可以通过Package.entryIfno.nfcdata获取 写入NFC设备的extra字段的值

Example

let extra = 'test_data';
Host.ui.openNFCWriteDeviceInfoPage(extra);

Kind: instance method of IUi
Since: 10056 打开NFC写设备数据的调试页面。 注意：该接口仅限于调试使用，只在DB包可用，线上版本不可用。仅特定插件可用。 在米家首页，手机接触到NFC设备时会读取写入的设备信息，读取成功后会自动打开相应的插件，插件可以通过Package.entryIfno.nfcdata获取

Example

let params={
 did: Device.deviceID,
 model: Device.model,
 extra: JSON.stringify({key:'value'})
}
Host.ui.openNFCWriteDeviceInfoDebugPage(params);

Kind: instance method of IUi
Since: 10052 打开常用设备/常用摄像机设置页面

Example

Host.ui.openCommonDeviceSettingPage(1);

Kind: instance method of IUi
Returns: object - 成功时：{code:0,data:[true|false]}
Since: 10052 是否需要展示常用摄像机小红点

Kind: instance method of IUi
Since: 10052 清除常用摄像机小红点

Kind: instance method of IUi
Param{object}param(optional)。: param.crontab(string)表示描述定时任务的字符串，当传入的值有效时进入页面会展示对应的定时状态 param.title(string)，要显示的标题 param.hideLegalTime(boolean)，是否隐藏法定节假日,(当服务器为外服时无法显示法定节假日)
Return{promise}: 成功时返回{code:0,data:{crontab:'xxxxxxx'}} 这个方法不会走reject，原生界面崩溃了代表传入的param.crontab不合法，native端解析失败。
Since: 10055 打开设置定时的页面。 这个页面不同于Service.scene.openTimerSettingPageWithOptions，这个页面只负责选择日期然后返回对应的crontab字符串

Kind: instance method of IUi
Since: 10056 打开固件自动更新页面（原生页面位置：设置-》检查更新-》固件自动更新）
Example

Host.ui.openFirmWareAutoOTAPage();