# ws-webview ws-webview api说明 ## Overview 只作用于文率科技内部webview的api说明，源码只作用于webview内部 ## Note 使用前最好先检测api对象是否存在 ```javascript tyof(window.postMessage)!= undefined && ... ``` ## web api | func | params | type | required/optional | comment | | --- | --- | --- | --- | --- | | PopWebView | undefined | undefined | optional | 关闭当前的webview导航 | | OpenWebView | url,title | string,string | required | 打开一个外部webview地址,完整的url | | PushGoodsDetailView | id | number | required | 打开一个商品详情界面 | | start | data | object | required | 初始播放 | | play | data | object | required | 恢复播放 | | stop | data | object | required | 暂停播放 | | reset | data | object | required | 重置播放 | | end | data | object | required | 播放结束，结果数据放在actionData.data中 | | sound | data({name,speed}) | object | required | 播放声音 | | geolocation | undefined | object | optional | 获取经纬度 | # > 可能你会觉得一个导航push的方法还要分开多个方法去调用很不爽，别急，新的导航还有一些小的问题还需要解决。 ToDo : 统一 NavigationPushFunc # ## Usage ```javascript const newFunc = { actionType : 'OpenWebView', actionData : { url : 'http://xxxxxxx', title : '标题', } } window.postMessage(JSON.Stringify(newFunc)) ``` # --- # ## WebView api | func | params | type | required/optional | comment | | --- | --- | --- | --- | --- | | start | undefined | undefined | required | 初始播放 | | play | undefined | undefined | optional | 恢复播放 | | stop | undefined | undefined | optional | 暂停播放 | | reset | undefined | undefined | optional | 重置播放 | | press | midi value | string | required | 按压键位传递的midi值 | | speed | timer speed | number | required | 速率 | | geolocation | longitude latitude | object | required | 经纬度 | # > 注意这部分是webview api ，但是func中的值是发送给web的actionType，所以web端开发者监听 WebView Api 中的func，来进行处理 ## Usage ```javascript window.document.addEventListener('message', function (e) { var data = JSON.parse(e.data); switch (data.actionType) { case 'play': //你的播放方法 break; } }); ``` ### addEventListener (data) * `data` _(String)_ - Type is string , need use `JSON.parse()` transform to object. * `actionType` _(String)_ - This WebView Api func params * `actionData` _(Object)_ - Return data