调用小程序能力

最近更新时间:2024-10-08 18:37:11

我的收藏

跳转小程序的标准设备详情页面

接口定义
sdk.goDeviceDetailPage({
reload?: boolean,
deviceId?: string,
isShareDevice?: boolean,
shareParams?: object | string,
}) => Promise
参数说明
参数名
参数描述
类型
必填
reload
如果为 true,则进入详情页后会重新拉取一次该设备的数据。
如果为 false,则进入详情页后会使用缓存的设备数据。
boolean
deviceId
可选,不传则使用当前设备的设备 ID。
string
isShareDevice
可选,设备是否为分享设备,不传则使用当前的 sdk.isShareDevice。
boolean
shareParams
可选,设备自定义分享参数。
object
string
返回值
返回一个 Promise。

跳转小程序的网关添加子设备页面

接口定义
sdk.goGatewayAddSubDevicePage(gatewayDeviceId: string);
参数说明
参数名
参数描述
类型
必填
gatewayDeviceId
网关设备 ID。
string
返回值
返回一个 Promise。

跳转小程序的反馈页面

接口定义
sdk.goFeedBackPage() => Promise
返回值
返回一个 Promise。

跳转小程序的设备信息页面

接口定义
sdk.goDeviceInfoPage({ deviceId?: string }) => Promise
参数说明
参数名
参数描述
类型
必填
deviceId
可选,不传则使用当前设备的设备 ID。
string
返回值
返回一个 Promise。

跳转小程序的修改设备名称页面

接口定义
sdk.goEditDeviceNamePage({ deviceId?: string, name?: string }) => Promise
参数说明
参数名
参数描述
类型
必填
deviceId
可选,不传则使用当前设备的设备 ID。
string
name
可选,不传则使用当前设备的 aliasName。
string
返回值
返回一个 Promise。

跳转其他设备的面板页面

接口定义
sdk.goDevicePanelPage(deviceId: string, customParams?: { passThroughParams: Record<string, string> }) => Promise
参数说明
参数名
参数描述
类型
必填
deviceId
要跳转面板的设备 ID。
string
passThroughParams
会被解析成查询字符串后,拼接到待跳转的面板的地址上。
Record<string, string>
返回值
返回一个 Promise。

跳转小程序的房间设置页面

接口定义
sdk.goRoomSettingPage({ deviceId?: string }) => Promise
参数说明
参数名
参数描述
类型
必填
deviceId
可选,不传则使用当前设备的设备 ID。
string
返回值
返回一个 Promise。

跳转小程序的设备分享页面

接口定义
sdk.goShareDevicePage({ deviceId?: string }) => Promise
参数说明
参数名
参数描述
类型
必填
deviceId
可选,不传则使用当前设备的设备 ID。
string
返回值
返回一个 Promise。

小程序刷新数据

要求小程序在当前 H5 面板关闭后进行一次数据刷新。
接口定义
sdk.reloadAfterUnmount() => Promise
返回值
返回一个 Promise。

跳转到其他小程序

跳转到另外一个小程序,适用于面板内购买增值服务等场景,入参与说明详见 wx.navigateToMiniprogram
注意:
只有将要目标小程序的 appid,加入白名单后才能调用此接口,如有需求请需联系客服开通。
接口定义
sdk.navigateToMiniprogram({ appid, extraData, envVersion }) => Promise
返回值
返回一个 Promise。

返回小程序的上一级页面

可用于主动关闭 H5 面板。
接口定义
sdk.navBack() => Promise
返回值
返回一个 Promise。

设置当前页面的分享内容

设置当前页面的分享内容,通过 wx.miniProgram.postMessage 向小程序推送分享信息,具体参考 小程序页面分享文档
接口定义
sdk.setShareConfig({ title: string, imgUrl: string? }) => Promise
参数说明
参数名
参数描述
类型
必填
title
分享的标题。
string
imgUrl
分享图片的地址,默认会取当前页面截图。
string
返回值
返回一个 Promise。

跳转云端定时

接口定义
sdk.goTimingProjectPage({ deviceId, isShareDevice, featureId } = {})
参数说明
参数名
参数描述
类型
必填
deviceId
可选,不传则使用当前设备的设备 ID。
string
isShareDevice
可选,设备是否为分享设备,不传则使用当前的 sdk.isShareDevice。
boolean
featureId
物模型标识符,传入参数后只会筛选出对应标识符的定时任务。
string
返回值
无返回值。

通知小程序触发震动

接口定义
sdk.triggerVibrateShort(type)
参数说明
参数名
参数描述
类型
必填
type
震动强度类型,有效值为:heavy、medium、light。
string
返回值
无返回值。

跳转到video设备的面板页面

接口定义
sdk.goVideoPanelPage({ deviceId, passThroughParams, redirect })
参数说明
参数名
参数描述
类型
必填
deviceId
要跳转面板的设备ID,不传取当前设备ID。
string
passThroughParams
会被解析成查询字符串后,拼接到待跳转的面板的地址上。
Record

redirect
跳转的方式, true 时为 redirectTo,false 时 navigateTo。
boolean
返回值
无返回值。