@hyext/hyext-webview-sdk
v1.2.8
Published
- 小游戏在 APP 端跨 webview 调用小程序 hyExt-SDK
Downloads
49
Keywords
Readme
@hyext/hyext-webview-sdk
- 小游戏在 APP 端跨 webview 调用小程序 hyExt-SDK
小程序端接入
安装
npm install @hyext/hyext-webview-sdk
引入
- 要在 hyExt 之后引入
import { ClientProxy } '@hyext/hyext-webview-sdk'
实例化
const client = new ClientProxy()
初始化
- 初始化成功后会返回当前的 unikey
- 重复初始化只会返回首次初始化成功的结果
- 获取的 unikey 要在 webview 加载链接参数中传入
const unikey = client.init({
unikey, // 可选,自定义唯一key时传入
debug: true, // 可选,开启debug
onLog(...params) { // 可选,托管debug事件
console.log('SDKProxyClient', params)
},
})
销毁
client.destroy()
获取当前 unikey
client.getUnikey()
自定义 unikey
- 用于标识响应哪个 webview 的消息;
- 若不传,则会随机一个长度为 6 的字符串;
- 自定义唯一标识一般规则:
- 由小程序 ID、小程序类型和实例化次数构成:
${extUuid}_${extType}_${count}
- extType 指的是浮窗或面板
- count 多个 webview 实例计数
- 由小程序 ID、小程序类型和实例化次数构成:
H5 小游戏接入
- 访问页面 url 查询串要带上 unikey 作为参数
http://your.location.com/index.html?unikey=yourunikey
页面引入
- 测试环境:
<script src="https://s1-static-dev.msstatic.com/hyext-webview-sdk/hyext-webview-sdk.min.js"></script>
- 正式环境:
<script src="https://s1-static.msstatic.com/hyext-webview-sdk/hyext-webview-sdk.min.js"></script>
开启 Debug
- 修复配置
HYExtWebviewProxy.Instance.setConfig({
debug: true
})
- 设置全局变量
window.HYExtWebViewDebug = true // 尽早设置
- url链接参数加debug = true
http://your.location.com/index.html?unikey=yourunikey&debug=true
手动初始化
- 当 url 参数中未定义 unikey 可通过手动 init 传入
HYExtWebviewProxy.Instance.init({
unikey: `${unikey}`
})