# Webview

• 方法

  • 创建Webview create
  • 创建并显示Webview open
  • 显示Webview show
  • 推入新的webview pushNewWeb
  • 关闭webview close
  • 重新加载页面 reload
  • 根据id获取webview对象 getWebviewById
  • 获取所有webview对象 all
  • 关闭当前webview closeSelf
  • 获取当前webview对象 currentWebview
  • 页面通讯 页面通讯
  • 触发事件 emit
  • 注册事件监听 on
  • 移除事件监听 off
  • 打开容器 pushWindow
  • 退出/关闭容器 pop
  • 退出到根容器 popToRoot
  • 返回到指定的Tab容器 switchTo
  • 获取导航栏容器栈信息 getStacks
  • 获取容器启动参数 pageExtra
  • 开启导航栏返回按钮拦截 interceptBackEvent
  • 释放导航栏返回按钮拦截 releaseInterceptBackEvent
  • 设置导航栏标题 setTitle
  • 设置导航栏背景颜色 setTitleBarColor
  • 设置导航栏底部线条颜色 setBarBottomLineColor
  • 显示或隐藏导航栏 setTitleVisible
  • 设置导航栏右上角按钮 setOptionMenu
  • 隐藏导航栏右上角按钮 hideOptionMenu
  • 显示导航栏右上角按钮 showOptionMenu
  • 设置右上角按钮badge setMenuBadge
  • 显示浮动按钮 showFloatMenu

# 创建webview

api名:create,创建Webview

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	webview链接和id,以及样式
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• 参数data说明

  参数名	类型	必填	说明
  url	String	是	webview地址
  id_wvobj	String	是	webviewid
  style	Object	可选	样式, 详见下表

• 参数data说明

  参数名	类型	必填	说明
  height	String	是	webview高度
  width	String	是	webview宽度

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

 foxsdk.webview.create({
    url: 'https://www.baidu.com/',
    id_wvobj: 'id111',
    style: {
        width: 200,
        height: 200
    }
}, ret => {
    console.log('webview/create===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 创建并显示webview

api名:open,创建并显示 Webview

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	webview链接和id,以及样式
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• 参数data说明

  参数名	类型	必填	说明
  url	String	是	webview地址
  id_wvobj	String	是	webviewid
  style	Object	可选	样式, 详见下表

• 参数data说明

  参数名	类型	必填	说明
  height	String	是	webview高度
  width	String	是	webview宽度

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 返回payload参数说明

  参数名	类型	说明
  id_wvobj	String	返回webviewid

• 示例代码

 foxsdk.webview.open({
    'url': 'https://www.baidu.com/',
    'id_wvobj': 'id111',
    'style': {
        'width': '200',
        'height': '200'
    }
}, ret => {
    console.log('webview/open===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 显示webview

api名:show,显示Webview

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	webview链接和id,以及样式
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• 参数data说明

  参数名	类型	必填	说明
  id_wvobj	String	是	webviewid

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

foxsdk.webview.show('id111', ret => {
    console.log('webview/index.vue1===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 推入新的webview

api名:pushNewWeb,push新的webview

• 支持平台

  Android	IOS	HarmonyOS
  √	√	×

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	url地址和转场动画
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• 参数data说明

  参数名	类型	必填	说明
  url	String	是	新webview 链接地址
  id_wvobj	String	是	webviewid
  animation	YXTransitionType	否	动画类型

• 参数YXTransitionType说明

  • 1： 淡入淡出
  • 2： 推进效果(android 左进入右出)
  • 3： 揭开效果(android 右进入左出)
  • 4： 慢慢进入并覆盖效果(Android 放大缩小)

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

foxsdk.webview.pushNewWeb({url: 'https://www.baidu.com/',id:'id111'}, ret => {
    console.log('webview/pushNewWeb===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 关闭webview

api名:close,关闭webview

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	url地址和转场动画
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• 参数data说明

  参数名	类型	必填	说明
  id_wvobj	String	是	webview id

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

foxsdk.webview.close(this.wvid, ret => {
    console.log('webview/close===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 重新加载当前页面

api名:reload

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

foxsdk.webview.reload(ret => {
    foxsdk.logger.info('webview/reload===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 根据id获取webview对象

api:getWebviewById

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  id_wvobj	String	是	webview的id
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 返回payload即为一个webviewObj

• webviewObj说明

  参数名	类型	必填	说明
  url	String	是	webview入口地址
  id_wvobj	String	是	webviewid

• 示例代码

foxsdk.webview.getWebviewById({id_wvobj:"id111"},ret => {
    console.log('webview/id_wvobj===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 获取所有webview对象

api名:all

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 返回payload参数说明

  参数名	类型	说明
  webs	Array	webviewObj数组

• webviewObj说明

  参数名	类型	必填	说明
  url	String	是	webview入口地址
  id_wvobj	String	是	webviewid

• 示例代码

foxsdk.webview.all(ret => {
    console.log('webview/all===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 关闭当前webview

api名:closeSelf,关闭当前webview，即关闭调用该方法的js所在页面所属的webview。

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

foxsdk.webview.closeSelf(ret => {
    console.log('webview/closeSelf===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 获取当前webview对象

api名: currentWebview,获取当前包含调用该js-api的页面的webview对象

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• payload数据说明

  参数名	类型	必填	说明
  url	String	是	webview入口地址
  id_wvobj	String	是	webviewid

• 示例代码

foxsdk.webview.currentWebview(ret => {
    console.log('webview/currentWebview===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 页面通讯

# 触发事件

api名:emit,触发全局的自定义事件。附加参数都会传给监听器回调。

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  eventName	String	是	事件名
  data	Object	可选	触发事件携带的附加参数
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

  let eventName = 'updateShoppingCart';
  let data = {
    ItemCount: 3
  };
foxsdk.webview.emit(eventName,data,ret => {
    console.log('webview/emit===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 注册事件监听

api名:on,监听全局的自定义事件。事件可以由foxsdk.webview.emit触发，回调函数会接收所有传入事件触发函数的额外参数。

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  eventName	String	是	事件名
  completedCB	Function	是	注册事件发生时的回调函数

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 示例代码

  let eventName = 'updateShoppingCart';
foxsdk.webview.on(eventName,ret => {
    console.log('webview/on===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 移除事件监听

api名:off,移除全局自定义事件监听器。

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  eventName	String	是	事件名
  completedCB	Function	可选	要注销的回调函数,如传则需要和on的回调函数一致才能正确移除

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

注意事项 移除事件名无论是否注册，都会返回 0成功

• 如果同时提供了事件与回调，则只移除这个回调的监听器;

• 提供的回调必须跟on的回调为同一个才能移除这个回调的监听器；

• 如果只提供了事件，则移除该事件所有的监听器；

• 示例代码

  let eventName = 'updateShoppingCart';
foxsdk.webview.off(eventName,ret => {
    console.log('webview/off===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 打开容器

api名:pushWindow 打开一个webview容器

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  url	string	是	离线包或在线h5地址
  param	Object	可选	容器导航栏样式参数
  pageExtra	Object	可选	具体业务参数

• param参数说明

  参数名	类型	必填	说明
  defaultTitle	string	可选	导航栏标题
  titleBarColor	string	可选	导航栏背景色 #ff0000
  titleColor	string	可选	导航栏文字颜色 #0000ff
  transparentTitle	string	可选	导航栏样式： always：永远显示，auto滑动显示，none不显示
  showsContainerTitle	bool	可选	是否展示页面标题
  closeCurrentWindow	bool	可选	是否从容器栈中移除当前容器

  • completedCB返回参数说明

    参数名	类型	说明
    status	Number	调用状态码 0成功, 1：持续，其他值失败
    message	String	调用结果信息
    payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.pushWindow({
    url: 'https://www.baidu.com/',
    param: {'defaultTitle':'理财','titleBarColor':'#ff00000'},
    pageExtra: {
        login_id: 200
      }
}, ret => {

});

# 退出/关闭容器

api名:pop 退出关闭当前容器，并指定回到导航栏栈新的top容器，或者关闭当前后回到指定的容器

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  backCount	string	可选	0,-1退出当前容器，-2后退2次，-3后退3次.....
  backBehavior	string	可选	'pop'表示当前webview canGoback时，不用goback直接关闭页面，其他情况，若能goback，则goback，不能goback，直接关闭页面

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.pop({
    backCount: '-1'
}, ret => {

});

# 退出到根容器

api名:popToRoot

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象 传{}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.popToRoot({}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 返回到指定的Tab容器

api名:switchTo

• 支持平台

  Android	IOS	HarmonyOS
  √	√	×

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  index	string	是	0：tab第一个页面，1:tab第二个页面

• 示例代码

 foxsdk.webview.switchTo({
    index: '0',
}, ret => {
      console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));

});

# 获取导航栏容器栈信息

api名:getStacks

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象 {}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 返回payload参数说明

  参数名	类型	说明
  containerStack	Array[ContainerObj]	容器对象数组

• 返回ContainerObj参数说明

  参数名	类型	说明
  url	string	为h5容器时，当前加载的地址
  index	string	处于导航栏栈的位置

• 示例代码

 foxsdk.webview.getStacks({}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 获取容器启动参数

api名:pageExtra

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象 {}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 无固定key-value值，pushWindow时传入参数

• 示例代码

 foxsdk.webview.pageExtra({
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 开启导航栏返回按钮拦截

api名:interceptBackEvent

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	否	api参数对象 {}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.interceptBackEvent(ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 释放导航栏返回按钮拦截

api名:releaseInterceptBackEvent

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象 {}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.releaseInterceptBackEvent(ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 设置导航栏标题

api名:setTitle

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  title	string	是	标题文字
  titleColor	string	否	标题文字颜色 16进制颜色，如#ff0000

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.setTitle({
    title: '登陆',
    titleColor:'#ff0000'
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 设置导航栏背景颜色

api名:setTitleBarColor

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  titleBarColor	string	是	标题文字颜色 16进制颜色，如#ff0000

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.setTitleBarColor({
    titleBarColor:'#ff0000'
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 设置导航栏底部线条颜色

api名:setBarBottomLineColor

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  color	string	是	标题文字颜色 16进制颜色，如#ff0000

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.setBarBottomLineColor({
    color:'#ff0000'
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 显示或隐藏导航栏

api名:setTitleVisible

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  visible	string	是	1显示，其他隐藏

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.setTitleVisible({
    visible:'1'
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 设置导航栏右上角按钮

api名:setOptionMenu

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Array	是	api参数对象[MenuObject]
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• MenuObject参数说明

  参数名	类型	必填	说明
  title	string	可选	按钮文字
  menu	Array	可选	按钮图片，支持本地内置和在线icon，内置icon: card ,clear,coupon,filter,home,message,more,plus,property,query,search,service,setting,shareing,version_change, 使用时 使用 icon_颜色， 例如显示黑色的更多按钮则icon为 more_black
  accessibilityLabel	string	可选	按钮旁白文字，盲人使用时会读出该按钮的功能

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.setOptionMenu({
    menu:[{'title':'更多','icon':'more_blak'},{'title':'消息','icon':'messge_black'}]
   
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 隐藏导航栏右上角按钮

api名:hideOptionMenu

• 支持平台

  | Android | IOS | HarmonyOS | |:----|:----------| :---------- | | √ | √ | × |

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象{}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.hideOptionMenu({
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 显示导航栏右上角按钮

api名:showOptionMenu

• 支持平台

  Android	IOS	HarmonyOS
  √	√	×

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象 {}
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.showOptionMenu({
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 设置右上角按钮badge

api名:setMenuBadge

• 支持平台

  Android	IOS	HarmonyOS
  √	√	×

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  badge	string	是	需要显示的badge数值超过99显示...
  index	string	是	从右到左的menu顺序0开始

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果

• 返回payload参数说明

  参数名	类型	说明
  	String

• 示例代码

 foxsdk.webview.setMenuBadge({
    badge:'10',
    index:'0'
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# 显示浮动按钮

api名:showFloatMenu

• 支持平台

  Android	IOS	HarmonyOS
  √	√	×

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	api参数对象
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• Object参数说明

  参数名	类型	必填	说明
  index	string	是	显示在第几个的右上角按钮下方(注意事项:index是是从右向左开始，并且index需要要小于设置的右下角个数)
  menu	Array	是[MenuObject]	浮动按钮菜单集合

• MenuObject参数说明

  参数名	类型	必填	说明
  title	string	可选	按钮文字
  icon	string	可选	按钮图片，支持本地内置和在线icon，内置icon: card ,clear,coupon,filter,home,message,more,plus,property,query,search,service,setting,shareing,version_change, 使用时 使用 icon_颜色， 例如显示黑色的更多按钮则icon为 more_black
  badge	string	可选	菜单按钮数字

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 1：持续，其他值失败
  message	String	调用结果信息
  payload	Object	详细结果 {}

• 示例代码

 foxsdk.webview.showFloatMenu({
     index:'0',
   menu:[{
    title: '更多',
    icon:'more_black'
   },
   {
    title: '首页',
    icon:'home_black'
   }

   ]
}, ret => {
    console.log('status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});