# 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