【小程序】基础API——面板API接口介绍

ty.preloadPanel

面板预下载

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备 id
extraInfo	PanelExtraParams		否	额外面板信息 当预下载的是二级面板时, 需要传递的额外信息
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

PanelExtraParams

属性	类型	默认值	必填	说明
productId	string		是	产品 id
productVersion	string		是	产品版本
i18nTime	string		是	面板多语言时间戳
bizClientId	string		是	容器 ID 可能是 uiid 的值也可能是 miniAppId 的值
uiType	string		否	包类型 RN RN 类型 SMART_MINIPG 小程序类型
uiPhase	string		否	包发布状态

ty.openPanel

跳转打开面板

不关心是跳转 RN 面板还是面板小程序

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备信息 Id
extraInfo	PanelExtraParams		否	额外面板信息 当跳转的是二级面板时, 需要传递的额外信息
initialProps	any		否	面板携带业务启动参数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

PanelExtraParams

属性	类型	默认值	必填	说明
productId	string		是	产品 id
productVersion	string		是	产品版本
i18nTime	string		是	面板多语言时间戳
bizClientId	string		是	容器 ID 可能是 uiid 的值也可能是 miniAppId 的值
uiType	string		否	包类型 RN RN 类型 SMART_MINIPG 小程序类型
uiPhase	string		否	包发布状态

ty.backToHomeAndOpenPanel

回到首页并打开面板

需引入BizKit，且在>=3.2.7版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备信息 Id
extraInfo	PanelExtraParams		否	额外面板信息 当跳转的是二级面板时, 需要传递的额外信息
initialProps	object		否	面板携带业务启动参数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

PanelExtraParams

属性	类型	默认值	必填	说明
productId	string		是	产品 id
productVersion	string		是	产品版本
i18nTime	string		是	面板多语言时间戳
bizClientId	string		是	容器 ID 可能是 uiid 的值也可能是 miniAppId 的值
uiType	string		否	包类型: RN - RN 类型 、SMART_MINIPG - 小程序类型
uiPhase	string		否	包发布状态

函数定义示例

/**
 * 回到首页并打开面板
 */
export function backToHomeAndOpenPanel(params: {
  /** 设备信息Id */
  deviceId: string;
  /**
   * 额外面板信息
   * 当跳转的是二级面板时, 需要传递的额外信息
   */
  extraInfo?: PanelExtraParams;
  /** 面板携带业务启动参数 */
  initialProps?: Record;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

  立即开发。