upNativeContainerModule 原生容器接口模块

模块概述

upNativeContainerModule 目前提供两类接口：一是原生容器的一些属性设置、前端订阅与解订阅事件的知会接口；二是为 TabBar 增加、移除新手引导蒙层的接口。 本模块的 Private 接口仅供 uplusapi 内部调用，其它使用者无需使用，也不能使用；但其它使用者可按需调用 Public 接口。

模块变更记录

• V4.0.0
  • 废弃接口addMaskForTabBar、removeMaskForTabBar

方法列表

Public:

• setResumeParam
• getResumeParam (iOS only)

Private:

• addEventListener
• removeEventListener
• sendMessageToNative

公共数据

所有数据均以JSON结构返回，由代码，信息和数据三部分组成

{
    "retCode": "000000", //接口状态标识码,错误标识码以18开头
    "retInfo": "操作成功",//接口信息说明
    "retData": null //业务数据
}

具体定义：返回数据通用

方法说明

addEventListener

addEventListener

使用说明

知会原生容器订阅了某事件。

适用性

params 输入参数

示例

upNativeContainerModule.addEventListener({ eventName: 'DeviceStateChanged' });

removeEventListener

removeEventListener

使用说明

知会原生容器解订阅了某事件。

适用性

params 输入参数

示例

upNativeContainerModule.removeEventListener({ eventName: 'DeviceStateChanged' });

setResumeParam

setResumeParam

使用说明

为指定容器设置 resume 参数。

适用性

params 输入参数

示例

upNativeContainerModule.setResumeParam({ data: {}, containerTag: 2 });

sendMessageToNative

sendMessageToNative

使用说明

知会原生容器通知广播某事件。

适用性

params 输入参数

示例

upNativeContainerModule.sendMessageToNative({ key: 'DeviceStateChanged',  body: '2222'});

• getResumeParam 获取当前容器的 resume 参数 (iOS only)

  getResumeParam()

适用性

params 输入参数：

无

错误返回 retCode说明：

使用通用retCode

正确返回 retData说明

使用通用retCode

示例

调用方式

uplusapi.upNativeContainerModule.getResumeParam().then((result) => console.log('resume param:', result.retData))
.catch((err) => console.log('err: ', err))

成功返回结果

{
  retCode: '000000',
  retData: {...}
  retInfo: '调用成功'
}