开发者文档中心

OpenAPI进入控制台

微信小程序 SDK · 2026-10-31

小程序生命周期与事件

自绘界面时连接客户端状态与页面生命周期。

下载接入包

订阅与显示

运行前

yunfu-sdk/examples/lifecycle.js · CommonJS 模块 · 接入包 0.3.14

  • 用于自绘页面;现成 yunfu-chat 已管理自身生命周期。
  • onShow/onHide/onUnload 分别转发给 controller,open 和 send 只从点击事件触发。
完整代码 · 20 行
yunfu-sdk/examples/lifecycle.jsJavaScript
const { YunfuMiniappClient } = require('../index');

// For a self-rendered page. Use the ready-made yunfu-chat component when no custom UI is needed.
function createSupportController(options, render) {
  const client = new YunfuMiniappClient(options);
  const unsubscribe = client.subscribe(render);
  return {
    async open() { client.setChatVisible(true); return client.connect(); },
    onShow() { client.onShow(); },
    onHide() { client.onHide(); },
    collapse() { client.setChatVisible(false); },
    send(text) { return client.sendText(text); },
    logout() {
      try { client.forgetSession(); }
      finally { try { unsubscribe(); } finally { client.destroy(); } }
    },
    destroy() { try { unsubscribe(); } finally { client.destroy(); } },
  };
}
module.exports = { createSupportController };
使用流程预览 · 示意图

帮助理解此示例的使用顺序,不执行代码或验证连接。

  1. 准备

    用于自绘页面;现成 yunfu-chat 已管理自身生命周期。 onShow/onHide/onUnload 分别转发给 controller,open 和 send 只从点击事件触发。

  2. 在项目中使用

    yunfu-sdk/examples/lifecycle.js · CommonJS 模块

  3. 核对结果

    首次 open 才连接;隐藏暂停轮询,卸载销毁,退出账号清理旧会话,不自动重放消息。

预期结果:首次 open 才连接;隐藏暂停轮询,卸载销毁,退出账号清理旧会话,不自动重放消息。

单实例约束

同一主机、key、entryId、userScope 已有存活实例时,新建会返回 SESSION_ALREADY_IN_USE。隐藏页面也占用实例;优先复用,或先 destroy 再创建。使用现成组件时,其内部管理生命周期,不要再为相同 scope 创建第二个客户端。

事件模型

当前 API 通过 subscribe(listener) 返回状态,取消订阅函数由 subscribe 返回;没有通用 on("message")、微信订阅消息或离线推送接口。前台恢复会补拉,首次历史不计为新未读。

官方原始接入文档

先按云蝠指南完成入口、智能体和服务配置,再按下列官方原文配置宿主权限或供应商资源。外部文档说明对应平台能力,不代表云蝠已开放其中全部接口;腾讯 SecretKey、签名密钥和管理 API Key 仅放服务端。参数、地域、类目和资费以官方当前页面及账号实际开通结果为准。

实现依据 · 仓库内路径
  • sdk/wechat-miniapp/index.d.ts
  • sdk/wechat-miniapp/components/yunfu-chat/index.js

文档描述当前源码能力;不等于你的宿主或生产环境已通过验收。