@kbapp/js-bridge 1.0.14-alpha.0 → 1.0.16-alpha.0

package/README.md

@@ -1,108 +0,0 @@
-# 开吧客户端桥接
-
-> ⚠️ 重要提示：本 SDK 基于 TypeScript 开发，所有 API 参数均带有明确的必填 / 选填类型标注。使用时请务必开启 TS 类型检查或在 IDE 中查看参数提示，必填项缺失会直接提示错误，选填项可按需传入，请勿忽略类型提示以避免使用异常。
-
-## 下载
-
-npm:
-
-```js
-npm i @kbapp/js-bridge
-```
-
-### 或通过 script 标签引入
-
-使用 unpkg CDN：
-
-```html
-<script src="https://unpkg.com/@kbapp/js-bridge@latest/dist/umd/index.js"></script>
-```
-
-使用 jsdelivr CDN：
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@kbapp/js-bridge@latest/dist/umd/index.js"></script>
-```
-
-> 通过 script 标签引入后，SDK 将作为全局变量 `kbBridge` 挂载在 window 对象上
-
-## 测试页面
-
-[https://unpkg.com/@kbapp/js-bridge@latest/examples/index.html](https://unpkg.com/@kbapp/js-bridge@latest/examples/index.html)
-
-## 示例
-
-```js
-import { saveImageToLocal } from '@kbapp/js-bridge'
-
-function saveImageHandle() {
-    saveImageToLocal({
-        imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
-        success() {
-            console.log('执行成功')
-        },
-    })
-}
-```
-
-### 通过 script 标签引入的使用示例
-
-```html
-<script src="https://unpkg.com/@kbapp/js-bridge@latest/dist/umd/index.js"></script>
-<script>
-async function saveImageHandle() {
-    // 通过全局变量kbBridge访问SDK功能
-    kbBridge.saveImageToLocal({
-        imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png',
-        success() {
-            console.log('保存成功')
-        },
-        fail(error) {
-            console.log('保存失败', error)
-        },
-    })
-}
-</script>
-```
-
-## API
-
-### 总览
-
-| 桥接 type | 方法 | 说明 | 链接 |
-| --------- | ---- | ---- | ---- |
-| - | `defineBridgeCallback` | 定义桥接调用的回调函数 | [查看文档](docs/api/define-bridge-callback.md) |
-| - | `runBridgeApi` | 执行桥接(无返回值) | [查看文档](docs/api/run-bridge-api.md) |
-| - | `runBridgeApiResponse` | 执行桥接(等待响应) | [查看文档](docs/api/run-bridge-api-response.md) |
-| - | `isAppVersionSupport` | 判断当前版本号是否支持 | [查看文档](docs/api/is-app-version-support.md) |
-| -1 | `closeWebView` | 关闭当前 webview | [查看文档](docs/api/close-web-view.md) |
-| - | `definePermissionUsage` | 定义隐私权限协议文案 | [查看文档](docs/api/define-permission-usage.md) |
-| - | `onAppSharePanelShow` | 监听分享面板打开事件 | [查看文档](docs/api/on-app-share-panel-show.md) |
-| 12 | `defineAppShareModel` | 定义页面分享内容 | [查看文档](docs/api/define-app-share-model.md) |
-| 58 | `openAppSharePanel` | 主动唤起分享面板 | [查看文档](docs/api/open-app-share-panel.md) |
-| 68 | `defineAppSharePanelState` | 定义分享面板控件布局 | [查看文档](docs/api/define-app-share-panel-state.md) |
-| 13 | `openPostEditor` | 唤起发帖器 | [查看文档](docs/api/open-post-editor.md) |
-| 26 | `scanQRCode` | 扫描二维码 | [查看文档](docs/api/scan-qrcode.md) |
-| 35 | `getAppBaseInfo` | 获取设备信息 | [查看文档](docs/api/get-app-base-info.md) |
-| 51 | `generateKBSign` | 生成 kbsign | [查看文档](docs/api/generate-kbsign.md) |
-| 56 | `checkForNewVersion` | 检测是否有新版本 | [查看文档](docs/api/check-for-new-version.md) |
-| 58 | `shareImage` | 分享海报 | [查看文档](docs/api/share-image.md) |
-| 64 | `setWebViewTitle` | 设置网页标题 | [查看文档](docs/api/set-web-view-title.md) |
-| 62 | `saveImageToLocal` | 保存图片到本地 | [查看文档](docs/api/save-image-to-local.md) |
-| 63 | `saveVideoToLocal` | 保存视频到本地 | [查看文档](docs/api/save-video-to-local.md) |
-| 69 | `reportDAEvent` | 上报数据埋点 | [查看文档](docs/api/report-daevent.md) |
-| - | `onLoopCheckAppLogin` | 启动轮询检查 APP 登录状态 | [查看文档](docs/api/on-loop-check-app-login.md) |
-| 31 | `getAppLoginInfo` | 获取 app 登录信息 | [查看文档](docs/api/get-app-login-info.md) |
-| 31 | `triggerAppLogin` | 触发 app 登录 | [查看文档](docs/api/trigger-app-login.md) |
-| 71 | `setScreenOrientation` | 设置屏幕方向 | [查看文档](docs/api/set-screen-orientation.md) |
-| 72 | `getAppSubscribeNotifyStatus` | 获取APP订阅通知状态 | [查看文档](docs/api/get-app-subscribe-notify-status.md) |
-| 73 | `openAppSubscribeNotifySettings` | 前往/打开 app订阅管理页面 | [查看文档](docs/api/open-app-subscribe-notify-settings.md) |
-| 1001 | `runAction` | 执行 action | [查看文档](docs/api/run-action.md) |
-
-| 类/枚举         | 说明                  |
-| --------------- | --------------------- |
-| `BridgeCode`    | kbapp 桥接状态码      |
-| `IS_KB_APP_ENV` | 是否在开吧 APP 环境中 |
-| `AppLoginInfo`  | 登录信息模型          |
-| `AppShareModel` | 应用分享模型          |
-| `AppBaseInfo`   | 设备信息模型          |