# 豆包应用插件开发者文档 > 豆包应用插件开发指南、JS API、组件和服务端 OpenAPI 文档。 ## 入门 - [认识豆包应用插件](/apps-plugin/docs/overview/introduction.md): :::warning 特别提示 本材料仅限定向受邀方内部使用,请注意严格保密。未经双方同意,严禁向第三方披露、转发或用于约定范围之外的其他用途。 ::: - [快速开始](/apps-plugin/docs/overview/quick-start.md) - [豆包应用插件 Demo](/apps-plugin/docs/overview/demo.md): Demo 代码附件 doubao-supermart-demo.zip - [包构成](/apps-plugin/docs/core-concepts/package-structure.md): :::info 提示 豆包应用插件采用代码化、声明式的目录结构:运行所需的所有元信息都内聚在产物包里,无需在平台做额外配置。理解包结构有助于你快速上手开发与排查问题。执行 dbx init 即可生成下述标准骨架。 ::: - [Manifest 配置规范](/apps-plugin/docs/core-concepts/manifest.md): :::info 提示 本指南解决什么:手把手讲清楚豆包应用插件项目根目录中的 manifest.yaml 怎么写——包括每个字段的定义与取值、鉴权与索权(scopes)声明,以及卡片固定字段(实体 schema + tool_card_binding)的绑定规则。看完即可独立完成一份可上传、可出卡的 Manifest。 ::: - [Skill 规范](/apps-plugin/docs/core-concepts/skill-guidelines.md): :::info 提示 豆包模型负责「听懂用户、做出决策」,开发者负责「提供能力、决定怎么呈现」,而 Skill 说明书就是开发者写给模型看的操作手册——它决定了模型能否在对的时机、用对的工具、出对的卡片,把开发者的服务准确交付给用户。 ::: - [MCP Server 概念与设计原则](/apps-plugin/docs/core-concepts/mcp-server-guidelines.md): :::info 提示 本文面向准备在豆包中提供业务工具能力的开发者,重点说明 MCP Server 的定位、能力边界和高层设计原则。本文不展开字段协议、开发步骤和调试命令;具体实现与精确协议分别参见 MCP Server 开发 和 MCP Server 协议规范。 ::: - [用户身份与权限模型](/apps-plugin/docs/core-concepts/identity-and-permissions.md): :::info 提示 本文档面向在豆包中提供业务工具能力的开发者,主要说明三个核心问题:平台如何识别应用、应用如何识别当前用户,以及受保护能力在满足用户授权条件后如何使用 ::: 本文主要介绍: 核心概念:AppID、OpenID、业务账号、业务会话与应用身份凭证 用户身份模型:获取 login_code、换取 OpenID、绑定业务账号并建立业务会话 权限使用模型:能力开通、权限声明、用户索权、系统权限与异常处理 开发者检查清单:环境隔离、密钥管理、账号绑定、会话管理与最小权限 相关文档:应用配置、登录指南及相关 API - [核心概念](/apps-plugin/docs/core-concepts/index.md): 包构成 Manifest 配置规范 Skill 规范 MCP Server 概念与设计原则 用户身份与权限模型 - [概览](/apps-plugin/docs/overview/index.md): 认识豆包应用插件 快速开始 豆包应用插件 Demo ## 产品设计 - [从 Query 开始](/apps-plugin/docs/design-principles/from-query.md): :::info 提示 做应用插件方案时,很多人第一反应是“我有哪些工具/接口,能拼出什么功能”。但在豆包里,用户不是来点按钮的,而是用一句话表达需求。所以正确的顺序应该反过来:先看清用户会怎么说,再决定豆包该怎么答,最后倒推出需要哪些工具和卡片。这一章就讲这套“从 Query 开始”的设计方法。 ::: - [设计对话中的卡片](/apps-plugin/docs/design-principles/card-design.md) - [航空行业示例](/apps-plugin/docs/industry-examples/aviation.md): :::info 提示 本文是航空行业的场景化模板用法示例,用于帮助航司 / 航旅类开发者快速理解:在豆包对话中,不同业务环节该如何选用卡片模板、如何配置。**注意:本文不是完整的 PRD 文档,**仅覆盖典型场景下的模板选型与配置建议,实际接入时请结合自身业务字段与「卡片模板说明」中的完整属性表进行设计。 ::: - [茶饮/餐饮行业示例](/apps-plugin/docs/industry-examples/tea-and-dining.md): :::info 提示 本文是外卖 / 即时零售行业的场景化模板用法示例,用于帮助餐饮、咖啡茶饮、即时零售类开发者快速理解:在豆包对话中,不同点单环节该选用哪个卡片模板、如何配置。注意:本文不是完整的 PRD 文档,仅覆盖典型场景下的模板选型与配置建议,实际接入时请结合自身业务字段与「卡片模板说明」中的完整属性表设计。 ::: - [设计原则](/apps-plugin/docs/design-principles/index.md): 从 Query 开始 卡片设计规范 - [行业方案示例](/apps-plugin/docs/industry-examples/index.md) ## 开发调试 - [MCP Server 开发](/apps-plugin/docs/skill-development/mcp-server.md): 本文面向 MCP Server 开发和联调人员,介绍从准备业务能力、创建服务、实现工具、适配返回,到配套 Skill 和完成验证的开发主线。工具设计原则参见 MCP Server 概念与设计原则,工具定义和返回结构参见 MCP Server 协议规范。 :::info 提示 **交付约束:**MCP Server 与配套 Skill 必须共同交付;Manifest 是项目接入和打包所需的配置产物;卡片按业务展示和交互需要选配。MCP Server 不会被打进版本包,发布前必须部署到可访问的服务地址。 ::: 本文不重复业务服务自身的编码、鉴权、稳定性和运维规范,也不展开 Skill、Manifest、卡片、调试工具和发布流程的专项细节。业务逻辑、业务鉴权、参数校验、超时重试、幂等、日志和敏感信息保护等继续遵循业务团队自身研发规范。 - [MCP Server 协议规范](/apps-plugin/docs/skill-development/mcp-server-protocol.md): **文档定位:**本文面向 MCP Server 开发者,是 MCP 工具对外定义、调用返回和兼容性要求的唯一规范来源。业务方需要实现标准 MCP 工具能力,以及本文约定的实体、执行结果和错误返回结构。Manifest 的配置字段由 Manifest 配置规范 说明,具体开发步骤由 MCP Server 开发 说明。 :::info 提示 **核心约定:**对外交付必须同时包含 MCP Server 和配套 Skill;卡片为可选产物。MCP 工具返回只表达业务事实与操作结果,不携带平台内部生成的运行时标识、内部路由字段或卡片模板配置。 ::: - [Skill 开发](/apps-plugin/docs/skill-development/overview.md): :::info 提示 Skill 是豆包应用插件中供模型理解和使用业务能力的运行态说明。MCP Server 定义工具“能做什么”,Skill 定义模型“什么时候调用、按什么顺序调用、缺少信息时如何追问,以及拿到结果后如何回复用户”。本页主要说明如何在豆包应用插件项目中编写可维护、可验证的 Skill。Skill 规范、MCP 协议、Manifest 字段和卡片渲染细节请分别阅读对应文档。 ::: - [开发概览](/apps-plugin/docs/frontend-development/overview.md): 本文档面向正在完成具体前端开发任务的开发者,说明从选择视图形态到调用宿主能力的完整开发路径。豆包应用插件前端主要提供三种面向用户的形态:Widget、Page 和多任务。三者解决的问题不同,但可以围绕同一个业务流程协作。 - [卡片(Widget)开发](/apps-plugin/docs/frontend-development/widget.md): Widget 是展示在豆包对话中的轻量视图,适合承载 MCP Tool 返回的结构化结果、确认操作和下一步入口。一个完整的出卡链路包括 Widget 注册、业务实体协议、MCP Tool 与 Widget 绑定,以及 Widget 对 View Data 的渲染。 - [全页(Full Page)开发](/apps-plugin/docs/frontend-development/full-page.md): Page 用于承载需要更多空间和连续交互的界面,例如详情、表单、地图和多步骤业务流程。本章说明从入口注册、数据读取、状态处理到联动调试的完整开发方式。 - [端工具(Client Tool)开发](/apps-plugin/docs/frontend-development/client-tools.md): 介绍豆包应用插件端工具的声明、注册、运行时限制、结果协议、卡片绑定,以及 Agent 调用的调试与验证方法。 - [对话相关 JS API 使用与权限声明](/apps-plugin/docs/frontend-development/conversation-js-api.md): 卡片、页面或 Worker 可以通过 @doubao-dev/framework/api 调用宿主开放能力。下表同时标注当前已公开能力和正在建设的能力;建设中的能力不可按现有 SDK API 使用。 - [关于证书](/apps-plugin/docs/backend-development/certificate.md): 证书用于在开发者服务端与豆包平台之间建立可信通信。它主要解决两类问题: 签名与验签:证明请求是谁发出的,并发现请求内容是否被篡改; 加密与解密:让手机号等敏感数据只能被指定的开发者服务端读取。 先记住两条规则:私钥用于签名或解密,必须由私钥所有者保管;证书中的公钥用于验签或加密,可以提供给通信对方。 开发者证书和平台证书方向相反,不能混用。cert_serial 只是选择证书的索引,不是公钥或私钥。 - [登录接入(服务端)](/apps-plugin/docs/backend-development/login.md): :::info 提示 本文面向负责后端、MCP Server 和账号系统的开发者,说明如何将自有账号体系接入豆包应用插件。接入完成后,平台能够在用户授权后代表用户调用 MCP 工具,业务服务端也可以通过平台提供的 OpenAPI 获取用户标识或已加密的用户信息。 ::: - [支付接入(服务端)](/apps-plugin/docs/backend-development/payment.md): :::info 提示 本文介绍如何为豆包应用插件接入支付能力。完成接入后,用户可以在应用插件中确认订单并完成付款,你的服务端可以查询支付结果、处理退款,并在商品或服务交付后通知豆包开放平台。 ::: 支付过程由三部分共同完成: 你的应用插件负责向服务端请求支付参数、创建平台订单并拉起收银台。 你的服务端负责保存开发者订单、生成签名、查询支付结果、处理回调、申请退款和通知履约完成。 豆包开放平台负责创建平台订单、提供收银台、处理支付和退款,并向你的服务端发送结果通知。 - [服务通知接入(服务端)](/apps-plugin/docs/backend-development/service-notification.md): 本文面向负责业务服务端、MCP Server 和通知策略的开发者,说明如何为豆包应用插件配置通知模板,并在业务事件发生后向指定用户发送服务通知。 服务通知是业务服务端主动调用平台 OpenAPI 的能力,不要求为每条通知新增 MCP Tool、Widget 或 Page。只有通知需要落地页、通知设置页或对话入口时,才需要同步开发前端或 MCP 能力。 - [多任务管理接入(服务端)](/apps-plugin/docs/backend-development/multi-task.md): 本文面向负责业务服务端、MCP Server 和任务状态管理的开发者,说明如何使用业务模板创建、更新和完成豆包应用插件中的远程任务。 当前服务端 OpenAPI 支持的是 remote 远程任务。remote_normal_v1 仅用于存量兼容,不应继续用于新增能力;不要因为配置 schema 接受 task_type: local,就把 local 模板交给远程任务接口。 - [系统权限授权接入(服务端)](/apps-plugin/docs/backend-development/system-permissions.md): 本文面向负责 MCP Server、业务服务端和联调验收的开发者,说明如何为工具声明系统权限、理解平台的授权判定,并在 Tool Call 中安全读取用户已授权的数据。 系统权限接入采用“双层授权”模型:工具配置的应用插件 Scope 与宿主系统权限必须同时满足。只有应用插件授权记录成功,并且当前设备的系统权限可用时,平台才会调用强依赖该权限的工具。 - [平台出口 IP(服务端)](/apps-plugin/docs/backend-development/platform-egress-ips.md) - [服务端开发](/apps-plugin/docs/backend-development/index.md): 关于证书 登录接入(服务端) 支付接入(服务端) 服务通知接入(服务端) 多任务管理接入(服务端) 系统权限授权接入(服务端) 平台出口 IP(服务端) - [Agent 与端侧交互](/apps-plugin/docs/client-framework/agent-interaction.md): 说明豆包应用插件 Client Tool 和 Agent 事件的运行链路、数据边界、错误处理、状态同步与端到端验证方法。 - [框架 API 参考](/apps-plugin/docs/client-framework/api-reference.md): 本页整理 @doubao-dev/framework 与 @doubao-dev/framework/config 的核心公开 API。 网络、路由、Storage、设备、登录和支付等宿主能力从 @doubao-dev/framework/api 暴露,应查阅对应端能力文档。 本页用于按名称查询 API;如果需要理解 API 在运行时中的位置,先阅读对应概念文章。 API 范围 相关概念 默认函数入口、defineApp、配置 API 框架概述与应用配置 生命周期回调、生命周期 Hooks、错误处理 生命周期与错误处理 View Data、View Context、组件状态 数据流与状态更新 React Hooks、组件树和线程模型 视图渲染与交互 - [CSS 能力清单](/apps-plugin/docs/client-framework/css-capabilities.md): 开发样式时,先通过本页确认 CSS 属性和取值是否可用。本页列出豆包应用插件当前文档承诺的 CSS 能力范围;需要进一步理解布局、选择器、文本承载和动画等行为差异时,再阅读样式与布局差异。豆包应用插件使用 Lynx 作为 UI 渲染器,其 CSS 能力不等同于浏览器的完整 CSS 规范。 判断规则: “支持的值”中的属性和值可以用于豆包应用插件; “不支持的值”需要使用其它布局、元素或样式方案替代; 未出现在本清单中的 CSS 属性或取值,当前不属于豆包应用插件的支持范围,不能默认与 Web 一致; 开发者只需要以本清单描述的当前能力为准,不自行推断未列出的属性或取值; 查询具体能力时,使用页面搜索直接输入属性名,例如 display、gap 或 text-overflow。同一行同时给出当前支持和明确不支持的取值。 注意 本清单只说明样式属性和值,选择器、节点、文本承载和布局行为请阅读样式与布局差异; 即使某个属性受支持,也应在真实目标端检查文本测量、滚动、层叠和动画效果; 关键容器应显式声明布局、尺寸和盒模型,不依赖 Web 默认样式; - [数据流与状态更新](/apps-plugin/docs/client-framework/data-flow.md): 豆包应用插件视图的数据分为宿主输入、运行上下文和组件状态。本文介绍这些数据的来源、读取方式、更新方向和生命周期边界。 - [应用插件框架](/apps-plugin/docs/client-framework/index.md): 本组文档不重复项目创建和首次运行流程。阅读前应已完成入门文档,并能够运行一个基础应用插件。 - [生命周期与错误处理](/apps-plugin/docs/client-framework/lifecycle.md): 生命周期用于描述应用、视图和组件从创建到销毁的状态变化。本文介绍三层生命周期、组件副作用与资源清理,以及不同错误来源的处理边界。 管理资源时,先判断资源属于哪个层级、是否依赖首次渲染,以及隐藏或销毁时应该暂停还是彻底释放。 - [框架概述与应用配置](/apps-plugin/docs/client-framework/overview.md): 豆包应用插件的端侧框架面向“AI 对话中的可交互服务”组织应用。本文依次介绍框架分层、应用组成、构建与运行机制,以及对应的工程约定和入口定义方式。 - [视图渲染与交互](/apps-plugin/docs/client-framework/rendering.md): 豆包应用插件使用 React 编程模型组织组件和状态,由 Lynx 渲染器负责生成原生 UI。本文介绍从 React 组件到原生视图的渲染过程,以及元素、事件和线程模型。 注意 组件写法接近 React,但运行环境不是浏览器,也没有 HTML DOM; Page 和 Widget 使用 SDK 提供的 UI 组件,不能直接使用 HTML 标签、DOM API 或浏览器事件模型; - [样式与布局差异](/apps-plugin/docs/client-framework/styling.md): 豆包应用插件使用 Lynx 作为 UI 渲染器,负责界面的布局与绘制。开发者可以继续使用熟悉的 CSS 写法;当涉及布局模型、选择器、尺寸单位和动画等能力差异时,以豆包应用插件当前支持的 CSS 能力为准。 本章按开发行为说明布局、尺寸与盒模型、定位、选择器、文本和动画的主要差异,并提供可直接采用的写法。需要确认某个 CSS 属性或取值时,统一查询 CSS 能力清单。 注意 本章说明常用能力、主要差异和推荐写法。完整支持范围请查询 CSS 能力清单;未列入清单的属性或取值,当前不属于支持范围,不能默认与 Web 一致; 关键容器应显式声明布局、尺寸和盒模型,不依赖浏览器默认样式; 页面最终由原生视图渲染,需要在真实目标端检查布局、文本和动画效果; - [text](/apps-plugin/docs/components/basic/text.md): 文本渲染组件,是展示文字内容的基础元件,支持文字样式配置。 - [canvas](/apps-plugin/docs/components/canvas/canvas.md): 画布组件,提供 2D/WebGL 绘图上下文,用于图形绘制、动画渲染等场景。 - [popup](/apps-plugin/docs/components/feedback/popup.md): 浮层弹出组件,从屏幕边缘滑入的容器,支持顶部、底部、左侧、右侧等方向。 - [button](/apps-plugin/docs/components/form/button.md): 按钮组件。 - [input](/apps-plugin/docs/components/form/input.md): 单行文本输入组件,支持多种输入类型(文本、数字、密码等)及受控/非受控模式。 - [picker-column](/apps-plugin/docs/components/form/picker-column.md): 滚轮选择列,单列数据选择,通常作为 PickerView 的子组件使用。 - [picker-divider](/apps-plugin/docs/components/form/picker-divider.md): 滚轮选择器分隔线组件,用于在 PickerColumn 之间展示文字或自定义内容。 - [picker-view](/apps-plugin/docs/components/form/picker-view.md): 滚轮选择器容器,支持多列组合选择。 - [radio-group](/apps-plugin/docs/components/form/radio-group.md): 单选按钮组,管理一组互斥的 Radio 选项,提供统一的值控制。 - [radio](/apps-plugin/docs/components/form/radio.md): 单选按钮,需配合 RadioGroup 使用。 - [slider](/apps-plugin/docs/components/form/slider.md): 滑块组件,支持在指定范围内选择连续或离散数值。 - [switch](/apps-plugin/docs/components/form/switch.md): 开关切换组件,用于二元状态(开/关)的交互控制。 - [text-area](/apps-plugin/docs/components/form/text-area.md): 多行文本输入组件,支持自动高度、字数限制等功能。 - [组件概述](/apps-plugin/docs/components/index.md): 豆包应用插件框架提供了覆盖界面布局、内容展示、用户交互、表单提交等核心场景的内置组件库,帮助开发者快速构建结构规范、交互流畅的应用插件界面。组件遵循统一设计标准,支持灵活配置,降低开发复杂度。 - [map-marker](/apps-plugin/docs/components/map/map-marker.md): 地图标记点组件,作为 Map 的子组件使用,支持自定义图标和动画。 - [map](/apps-plugin/docs/components/map/map.md): 地图展示组件,支持标记点、路线、多边形等覆盖物,以及平移、缩放等交互。 - [audio](/apps-plugin/docs/components/media/audio.md): 音频播放组件,提供不占用页面布局的音频播放与实例控制能力。 - [camera](/apps-plugin/docs/components/media/camera.md): 相机预览与拍摄组件,提供拍照和录像能力。 - [image](/apps-plugin/docs/components/media/image.md): 图片展示组件,支持加载本地或网络图片资源,提供多种裁剪和缩放模式。 - [long-image](/apps-plugin/docs/components/media/long-image.md): 长图加载与展示组件,支持分段懒加载,适用于超长图片的高性能渲染。 - [markdown](/apps-plugin/docs/components/media/markdown.md): Markdown 渲染组件,用于渲染 Markdown 内容,支持打字机动画、文本选择和文本标注。 - [rich-text](/apps-plugin/docs/components/media/rich-text.md): 富文本组件,支持 HTML 字符串或结构化节点,并自动同步内容高度。写法与小程序 rich-text 兼容。 - [svg](/apps-plugin/docs/components/media/svg.md): SVG 图形渲染组件,支持内联展示 SVG 格式图片。 - [video](/apps-plugin/docs/components/media/video.md): 视频播放组件,支持本地和网络视频资源的播放控制。 - [web-view](/apps-plugin/docs/components/open/web-view.md): 网页视图组件,用于在应用插件页面内承载 H5 页面。 - [theme-provider](/apps-plugin/docs/components/theme/theme-provider.md): 主题配置组件,为其包裹的子组件统一指定豆包的浅色 / 深色模式。 只影响颜色相关的 CSS 变量,不涉及圆角、间距、字号等其他样式。 - [list](/apps-plugin/docs/components/view-container/list.md): 高性能列表组件,适用于渲染大量数据,支持垂直滚动和按需渲染。 - [movable-area](/apps-plugin/docs/components/view-container/movable-area.md): 可移动区域组件,定义子视图可拖拽移动的范围边界。 - [movable-view](/apps-plugin/docs/components/view-container/movable-view.md): 可移动视图组件,支持拖拽移动、双指缩放、惯性滑动、越界回弹等交互。 - [scroll-view](/apps-plugin/docs/components/view-container/scroll-view.md): 可滚动容器,支持垂直和水平方向内容滚动,适用于内容超出可视区域的场景。 - [swiper-item](/apps-plugin/docs/components/view-container/swiper-item.md): 轮播项组件,用于包裹单个轮播内容,必须作为 Swiper 的直接子组件使用。 - [swiper](/apps-plugin/docs/components/view-container/swiper.md): 轮播容器组件,支持自动播放、循环、自定义动画等功能。子节点须为 SwiperItem 组件。 - [view](/apps-plugin/docs/components/view-container/view.md): 基础布局容器,用于组织和嵌套其他组件,支持 Flexbox 布局。 - [AI 辅助开发](/apps-plugin/docs/development-tools/ai-assisted-development.md) - [CLI 命令总览](/apps-plugin/docs/development-tools/commands.md): :::info 提示 下面按开发流程介绍常用的 dbx 命令。除初始化外,请在项目根目录运行这些命令。想查看某条命令的完整用法,可以在命令后加 --help。 ::: - [真机预览](/apps-plugin/docs/development-tools/device-debugging.md): 真机预览用于在豆包 App 中体验应用插件的指定版本。你需要先在豆包开发者平台选择要预览的应用插件和版本,获取该版本的体验二维码,再使用豆包 App 扫码进入调试状态。进入调试状态后,通过「应用插件 Debugger」发送 Query,即可查看该版本的实际响应。 - [查看豆包 UID](/apps-plugin/docs/development-tools/doubao-uid.md): 豆包 UID 是豆包账号的标识,可用于配置应用插件的体验白名单和内测用户名单。本文说明如何查看并提供自己的豆包 UID。 - [开发工具](/apps-plugin/docs/development-tools/index.md): CLI 安装与配置 CLI 命令总览 本地调试与预览 真机预览 AI 辅助开发 查看豆包 UID - [CLI 安装与配置](/apps-plugin/docs/development-tools/installation.md): :::info 提示 Doubao Dev CLI 是豆包应用插件的命令行工具,可用于完成项目初始化、登录、开发调试、产物校验和云构建等工作。本文说明安装、登录验证和首次项目初始化。 ::: - [本地调试与预览](/apps-plugin/docs/development-tools/local-debugging.md) - [自动化评测](/apps-plugin/docs/evaluation/automated-evaluation.md): :::info 提示 DBX Eval 用于评估豆包应用插件的 Agent、MCP Server、Skill 与卡片渲染的端到端表现。一次完整评测会完成项目检查、MCP 探索、用例生成、多轮轨迹、评分、失败归因、准出判定和 HTML 报告。 建议从项目根目录打开 Coding Agent,让它使用 dbx-eval Skill 运行评测、分析报告,并在修复后重新验证。你也可以按下文的 CLI 示例自己运行,或将命令接入 CI。 ::: - [评测](/apps-plugin/docs/evaluation/index.md): 评测文档用于说明如何使用 DBX Eval 检查豆包应用插件的 Agent、MCP Server、Skill 与卡片渲染质量。 - [arrayBufferToBase64](/apps-plugin/docs/js-api/basic/arrayBufferToBase64.md): 将 ArrayBuffer 转换为 Base64 字符串。 - [authorize](/apps-plugin/docs/js-api/basic/authorize.md): 提前向用户发起指定 scope 的授权;scope.healthData 仅用于选择 iOS HealthKit 系统授权路径。 - [base64ToArrayBuffer](/apps-plugin/docs/js-api/basic/base64ToArrayBuffer.md): 将 Base64 字符串转换为 ArrayBuffer。 - [canIUse](/apps-plugin/docs/js-api/basic/canIUse.md): 检测当前环境是否支持指定 API 或能力。 - [getAccountInfo](/apps-plugin/docs/js-api/basic/getAccountInfo.md): 异步获取账号信息。 - [getAccountInfoSync](/apps-plugin/docs/js-api/basic/getAccountInfoSync.md): 同步获取账号信息。 - [getPerformance](/apps-plugin/docs/js-api/basic/getPerformance.md): 获取当前应用插件的性能数据。 Entry 由客户端保存;getEntries*() 同步查询当前快照,observer 只接收新完成的 Entry。 - [getSetting](/apps-plugin/docs/js-api/basic/getSetting.md): 获取用户当前的应用授权设置。 - [基础](/apps-plugin/docs/js-api/basic/index.md): arrayBufferToBase64 authorize base64ToArrayBuffer canIUse getAccountInfo getAccountInfoSync getPerformance getSetting openSetting 系统 - [openSetting](/apps-plugin/docs/js-api/basic/openSetting.md): 打开应用插件授权设置页面 - [getAppAuthorizeSetting](/apps-plugin/docs/js-api/basic/system/getAppAuthorizeSetting.md): 获取豆包客户端的系统授权设置。 调用只读取当前系统授权状态,不会申请权限或触发系统授权弹窗。原有状态字段固定返回 authorized、denied 或 not determined,精细授权字段用于区分部分、只读、只写、前后台等能力。 - [getAppBaseInfo](/apps-plugin/docs/js-api/basic/system/getAppBaseInfo.md): 获取应用基础信息。 - [getAppBaseInfoSync](/apps-plugin/docs/js-api/basic/system/getAppBaseInfoSync.md): 获取应用基础信息。 - [getSystemInfo](/apps-plugin/docs/js-api/basic/system/getSystemInfo.md): 获取系统信息。 - [getSystemInfoSync](/apps-plugin/docs/js-api/basic/system/getSystemInfoSync.md): 同步获取系统信息。 - [getSystemSetting](/apps-plugin/docs/js-api/basic/system/getSystemSetting.md): 获取设备设置。 - [getWindowInfo](/apps-plugin/docs/js-api/basic/system/getWindowInfo.md): 获取窗口信息。 - [getWindowInfoSync](/apps-plugin/docs/js-api/basic/system/getWindowInfoSync.md): 获取窗口信息。 - [系统](/apps-plugin/docs/js-api/basic/system/index.md): getAppAuthorizeSetting getAppBaseInfo getAppBaseInfoSync getSystemInfo getSystemInfoSync getSystemSetting getWindowInfo getWindowInfoSync onThemeChange - [onThemeChange](/apps-plugin/docs/js-api/basic/system/onThemeChange.md): 监听应用主题变化。 当用户在系统设置或豆包客户端内切换浅色、深色主题时触发。回调参数中的 theme 表示切换后的主题,可与 getAppBaseInfo 返回的 theme 字段配合使用。 - [通用错误处理](/apps-plugin/docs/js-api/common-errors.md) - [createCustomEvent](/apps-plugin/docs/js-api/custom/createCustomEvent.md): 创建一组用于发送和监听自定义事件的函数。 - [自定义通信](/apps-plugin/docs/js-api/custom/index.md): createCustomEvent - [数据分析](/apps-plugin/docs/js-api/data-analysis/index.md): reportEvent - [reportEvent](/apps-plugin/docs/js-api/data-analysis/reportEvent.md): 上报数据分析事件。 - [加速度计](/apps-plugin/docs/js-api/device/accelerometer/index.md): onAccelerometerChange startAccelerometer stopAccelerometer - [onAccelerometerChange](/apps-plugin/docs/js-api/device/accelerometer/onAccelerometerChange.md): 监听加速度数据变化事件。 - [startAccelerometer](/apps-plugin/docs/js-api/device/accelerometer/startAccelerometer.md): 开始监听加速度。 - [stopAccelerometer](/apps-plugin/docs/js-api/device/accelerometer/stopAccelerometer.md): 停止监听加速度。 - [checkIsOpenAccessibility](/apps-plugin/docs/js-api/device/accessibility/checkIsOpenAccessibility.md): 检测无障碍能力是否开启。 - [无障碍](/apps-plugin/docs/js-api/device/accessibility/index.md): checkIsOpenAccessibility - [getBatteryInfo](/apps-plugin/docs/js-api/device/battery/getBatteryInfo.md): 获取电池信息。 - [电池](/apps-plugin/docs/js-api/device/battery/index.md): getBatteryInfo onBatteryInfoChange - [onBatteryInfoChange](/apps-plugin/docs/js-api/device/battery/onBatteryInfoChange.md): 监听电池信息变化事件。 - [closeBLEConnection](/apps-plugin/docs/js-api/device/bluetooth/closeBLEConnection.md): 关闭 BLE 连接。 - [closeBluetoothAdapter](/apps-plugin/docs/js-api/device/bluetooth/closeBluetoothAdapter.md): 关闭蓝牙适配器。 - [createBLEConnection](/apps-plugin/docs/js-api/device/bluetooth/createBLEConnection.md): 创建 BLE 连接。 - [getBLEDeviceCharacteristics](/apps-plugin/docs/js-api/device/bluetooth/getBLEDeviceCharacteristics.md): 获取 BLE 特征值列表。 - [getBLEDeviceRSSI](/apps-plugin/docs/js-api/device/bluetooth/getBLEDeviceRSSI.md): 获取 BLE 设备 RSSI。 - [getBLEDeviceServices](/apps-plugin/docs/js-api/device/bluetooth/getBLEDeviceServices.md): 获取 BLE 服务列表。 - [getBLEMTU](/apps-plugin/docs/js-api/device/bluetooth/getBLEMTU.md): 获取 BLE MTU。 - [getBluetoothAdapterState](/apps-plugin/docs/js-api/device/bluetooth/getBluetoothAdapterState.md): 获取蓝牙适配器状态。 - [getBluetoothDevices](/apps-plugin/docs/js-api/device/bluetooth/getBluetoothDevices.md): 获取当前蓝牙模块发现的设备列表。 - [getConnectedBluetoothDevices](/apps-plugin/docs/js-api/device/bluetooth/getConnectedBluetoothDevices.md): 获取已连接的蓝牙设备列表。 - [蓝牙](/apps-plugin/docs/js-api/device/bluetooth/index.md): closeBLEConnection closeBluetoothAdapter createBLEConnection getBLEDeviceCharacteristics getBLEDeviceRSSI getBLEDeviceServices getBLEMTU getBluetoothAdapterState getBluetoothDevices getConnectedBluetoothDevices isBluetoothDevicePaired makeBluetoothPair notifyBLECharacteristicValueChange onBLECharacteristicValueChange onBLEConnectionStateChange onBluetoothAdapterStateChange onBluetoothDeviceFound openBluetoothAdapter readBLECharacteristicValue setBLEMTU startBluetoothDevicesDiscovery stopBluetoothDevicesDiscovery writeBLECharacteristicValue - [isBluetoothDevicePaired](/apps-plugin/docs/js-api/device/bluetooth/isBluetoothDevicePaired.md): 查询蓝牙设备是否已经配对。 - [makeBluetoothPair](/apps-plugin/docs/js-api/device/bluetooth/makeBluetoothPair.md): 发起蓝牙配对。 - [notifyBLECharacteristicValueChange](/apps-plugin/docs/js-api/device/bluetooth/notifyBLECharacteristicValueChange.md): 订阅 BLE 特征值变化。 - [onBLECharacteristicValueChange](/apps-plugin/docs/js-api/device/bluetooth/onBLECharacteristicValueChange.md): 注册 BLE 特征值变化回调。 - [onBLEConnectionStateChange](/apps-plugin/docs/js-api/device/bluetooth/onBLEConnectionStateChange.md): 注册 BLE 连接状态变化回调。 - [onBluetoothAdapterStateChange](/apps-plugin/docs/js-api/device/bluetooth/onBluetoothAdapterStateChange.md): 注册蓝牙适配器状态变化回调。 - [onBluetoothDeviceFound](/apps-plugin/docs/js-api/device/bluetooth/onBluetoothDeviceFound.md): 注册发现蓝牙设备回调。 - [openBluetoothAdapter](/apps-plugin/docs/js-api/device/bluetooth/openBluetoothAdapter.md): 打开蓝牙适配器。 - [readBLECharacteristicValue](/apps-plugin/docs/js-api/device/bluetooth/readBLECharacteristicValue.md): 读取 BLE 特征值。 - [setBLEMTU](/apps-plugin/docs/js-api/device/bluetooth/setBLEMTU.md): 设置 BLE MTU。 - [startBluetoothDevicesDiscovery](/apps-plugin/docs/js-api/device/bluetooth/startBluetoothDevicesDiscovery.md): 开始搜索附近的蓝牙设备。 - [stopBluetoothDevicesDiscovery](/apps-plugin/docs/js-api/device/bluetooth/stopBluetoothDevicesDiscovery.md): 停止搜索附近的蓝牙设备。 - [writeBLECharacteristicValue](/apps-plugin/docs/js-api/device/bluetooth/writeBLECharacteristicValue.md): 写入 BLE 特征值。 - [addPhoneCalendar](/apps-plugin/docs/js-api/device/calendar/addPhoneCalendar.md): 向系统日历添加事件。 - [addPhoneRepeatCalendar](/apps-plugin/docs/js-api/device/calendar/addPhoneRepeatCalendar.md): 向系统日历添加重复事件。 - [deletePhoneCalendar](/apps-plugin/docs/js-api/device/calendar/deletePhoneCalendar.md): 按标题和原始时间删除全部匹配的系统日历事件。 - [日历](/apps-plugin/docs/js-api/device/calendar/index.md): addPhoneCalendar addPhoneRepeatCalendar deletePhoneCalendar - [getClipboardData](/apps-plugin/docs/js-api/device/clipboard/getClipboardData.md): 获取剪贴板内容。 - [剪贴板](/apps-plugin/docs/js-api/device/clipboard/index.md): getClipboardData setClipboardData - [setClipboardData](/apps-plugin/docs/js-api/device/clipboard/setClipboardData.md): 设置系统剪贴板内容。 - [罗盘](/apps-plugin/docs/js-api/device/compass/index.md): onCompassChange startCompass stopCompass - [onCompassChange](/apps-plugin/docs/js-api/device/compass/onCompassChange.md): 监听罗盘数据变化事件。 - [startCompass](/apps-plugin/docs/js-api/device/compass/startCompass.md): 开始监听罗盘。 - [stopCompass](/apps-plugin/docs/js-api/device/compass/stopCompass.md): 停止监听罗盘。 - [getRandomValues](/apps-plugin/docs/js-api/device/crypto/getRandomValues.md): 获取安全随机数。 - [加密](/apps-plugin/docs/js-api/device/crypto/index.md): getRandomValues - [设备方向](/apps-plugin/docs/js-api/device/device-motion/index.md): onDeviceMotionChange startDeviceMotionListening stopDeviceMotionListening - [onDeviceMotionChange](/apps-plugin/docs/js-api/device/device-motion/onDeviceMotionChange.md): 监听设备方向变化事件。 - [startDeviceMotionListening](/apps-plugin/docs/js-api/device/device-motion/startDeviceMotionListening.md): 开始监听设备方向变化。 - [stopDeviceMotionListening](/apps-plugin/docs/js-api/device/device-motion/stopDeviceMotionListening.md): 停止监听设备方向变化。 - [陀螺仪](/apps-plugin/docs/js-api/device/gyroscope/index.md): onGyroscopeChange startGyroscope stopGyroscope - [onGyroscopeChange](/apps-plugin/docs/js-api/device/gyroscope/onGyroscopeChange.md): 监听陀螺仪数据变化事件。 - [startGyroscope](/apps-plugin/docs/js-api/device/gyroscope/startGyroscope.md): 开始监听陀螺仪。 - [stopGyroscope](/apps-plugin/docs/js-api/device/gyroscope/stopGyroscope.md): 停止监听陀螺仪。 - [getBeacons](/apps-plugin/docs/js-api/device/ibeacon/getBeacons.md): 获取已搜索到的 iBeacon 列表。 - [iBeacon](/apps-plugin/docs/js-api/device/ibeacon/index.md): getBeacons startBeaconDiscovery stopBeaconDiscovery - [startBeaconDiscovery](/apps-plugin/docs/js-api/device/ibeacon/startBeaconDiscovery.md): 开始搜索附近的 iBeacon。 - [stopBeaconDiscovery](/apps-plugin/docs/js-api/device/ibeacon/stopBeaconDiscovery.md): 停止搜索附近的 iBeacon。 - [设备](/apps-plugin/docs/js-api/device/index.md): 电池 电话 短信 基础信息 加密 加速度计 剪贴板 蓝牙 罗盘 屏幕 日历 扫码 设备方向 陀螺仪 网络 无障碍 震动 iBeacon Wi-Fi - [getDeviceInfo](/apps-plugin/docs/js-api/device/info/getDeviceInfo.md): 获取设备基础信息。 - [getDeviceInfoSync](/apps-plugin/docs/js-api/device/info/getDeviceInfoSync.md): 同步获取设备基础信息。 - [基础信息](/apps-plugin/docs/js-api/device/info/index.md): getDeviceInfo getDeviceInfoSync - [getNetworkType](/apps-plugin/docs/js-api/device/network/getNetworkType.md): 获取当前网络类型。 - [网络](/apps-plugin/docs/js-api/device/network/index.md): getNetworkType onNetworkStatusChange - [onNetworkStatusChange](/apps-plugin/docs/js-api/device/network/onNetworkStatusChange.md): 监听网络状态变化事件。 - [电话](/apps-plugin/docs/js-api/device/phone/index.md): makePhoneCall - [makePhoneCall](/apps-plugin/docs/js-api/device/phone/makePhoneCall.md): 拨打电话。 - [扫码](/apps-plugin/docs/js-api/device/scan/index.md): scanCode - [scanCode](/apps-plugin/docs/js-api/device/scan/scanCode.md): 调起扫码能力。 - [disableUserScreenRecord](/apps-plugin/docs/js-api/device/screen/disableUserScreenRecord.md): 禁止用户录屏。 - [enableUserScreenRecord](/apps-plugin/docs/js-api/device/screen/enableUserScreenRecord.md): 允许用户录屏。 - [getScreenBrightness](/apps-plugin/docs/js-api/device/screen/getScreenBrightness.md): 获取屏幕亮度。 - [屏幕](/apps-plugin/docs/js-api/device/screen/index.md): disableUserScreenRecord enableUserScreenRecord getScreenBrightness onUserCaptureScreen onUserScreenRecord setKeepScreenOn setScreenBrightness - [onUserCaptureScreen](/apps-plugin/docs/js-api/device/screen/onUserCaptureScreen.md): 监听用户主动截屏事件。 - [onUserScreenRecord](/apps-plugin/docs/js-api/device/screen/onUserScreenRecord.md): 监听用户录屏事件。 - [setKeepScreenOn](/apps-plugin/docs/js-api/device/screen/setKeepScreenOn.md): 设置屏幕常亮状态。 - [setScreenBrightness](/apps-plugin/docs/js-api/device/screen/setScreenBrightness.md): 设置屏幕亮度。 - [短信](/apps-plugin/docs/js-api/device/sms/index.md): sendSms - [sendSms](/apps-plugin/docs/js-api/device/sms/sendSms.md): 拉起系统短信发送面板。 - [震动](/apps-plugin/docs/js-api/device/vibration/index.md): vibrateLong vibrateShort - [vibrateLong](/apps-plugin/docs/js-api/device/vibration/vibrateLong.md): 触发长震动。 - [vibrateShort](/apps-plugin/docs/js-api/device/vibration/vibrateShort.md): 触发短震动。 - [connectWifi](/apps-plugin/docs/js-api/device/wifi/connectWifi.md): 连接指定 Wi-Fi。 - [getConnectedWifi](/apps-plugin/docs/js-api/device/wifi/getConnectedWifi.md): 获取当前已连接 Wi-Fi 信息。 - [getWifiList](/apps-plugin/docs/js-api/device/wifi/getWifiList.md): 获取 Wi-Fi 列表。 - [Wi-Fi](/apps-plugin/docs/js-api/device/wifi/index.md): connectWifi getConnectedWifi getWifiList onWifiConnected setWifiList startWifi stopWifi - [onWifiConnected](/apps-plugin/docs/js-api/device/wifi/onWifiConnected.md): 监听连接上 Wi-Fi 的事件。 - [setWifiList](/apps-plugin/docs/js-api/device/wifi/setWifiList.md): 设置 Wi-Fi 预设列表(iOS 特有)。 - [startWifi](/apps-plugin/docs/js-api/device/wifi/startWifi.md): 初始化 Wi-Fi 模块。 - [stopWifi](/apps-plugin/docs/js-api/device/wifi/stopWifi.md): 关闭 Wi-Fi 模块。 - [getFileSystemManager](/apps-plugin/docs/js-api/file-system/getFileSystemManager.md): 获取文件系统管理器。 - [文件系统](/apps-plugin/docs/js-api/file-system/index.md): getFileSystemManager - [JS API 概览](/apps-plugin/docs/js-api/index.md) - [getLocation](/apps-plugin/docs/js-api/location/getLocation.md): 获取设备当前的地理位置信息。 - [定位](/apps-plugin/docs/js-api/location/index.md): getLocation onLocationChange onLocationChangeError startLocationUpdate stopLocationUpdate - [onLocationChange](/apps-plugin/docs/js-api/location/onLocationChange.md): 注册地理位置变化回调。 - [onLocationChangeError](/apps-plugin/docs/js-api/location/onLocationChangeError.md): 注册位置更新异常回调。 - [startLocationUpdate](/apps-plugin/docs/js-api/location/startLocationUpdate.md): 开始接收位置更新。 - [stopLocationUpdate](/apps-plugin/docs/js-api/location/stopLocationUpdate.md): 停止接收位置更新。 - [chooseImage](/apps-plugin/docs/js-api/media/chooseImage.md): 选择图片。 - [compressImage](/apps-plugin/docs/js-api/media/compressImage.md): 压缩图片。 - [createInnerAudioContext](/apps-plugin/docs/js-api/media/createInnerAudioContext.md): 创建一个内部音频上下文。 - [getBackgroundAudioManager](/apps-plugin/docs/js-api/media/getBackgroundAudioManager.md): 获取全局唯一的背景音频管理器。 - [getImageInfo](/apps-plugin/docs/js-api/media/getImageInfo.md): 获取图片信息。 - [getRecorderManager](/apps-plugin/docs/js-api/media/getRecorderManager.md): 获取全局唯一的录音管理器。 - [媒体](/apps-plugin/docs/js-api/media/index.md): chooseImage compressImage createInnerAudioContext getBackgroundAudioManager getImageInfo getRecorderManager previewImage saveImageToPhotosAlbum - [previewImage](/apps-plugin/docs/js-api/media/previewImage.md): 预览图片。 - [saveImageToPhotosAlbum](/apps-plugin/docs/js-api/media/saveImageToPhotosAlbum.md): 保存图片到系统相册。 需要先确保应用已具备写入系统相册的权限。 - [connectSocket](/apps-plugin/docs/js-api/network/connectSocket.md): 创建一个 WebSocket 连接,并返回可操作该连接的 SocketTask。 该 API 会同步返回 SocketTask,但连接创建本身是异步过程。调用方应先在返回的 SocketTask 上注册事件回调,再等待 onOpen 表示连接可用。后续发送消息使用 SocketTask.send,关闭连接使用 SocketTask.close。 - [downloadFile](/apps-plugin/docs/js-api/network/downloadFile.md): 下载文件,并返回可取消、可监听进度的 DownloadTask。 - [网络](/apps-plugin/docs/js-api/network/index.md): connectSocket downloadFile request uploadFile - [request](/apps-plugin/docs/js-api/network/request.md): 发起网络请求。 request 本身不接受泛型参数;如需业务数据类型,请读取 result.data 后再做类型收窄或断言。 - [uploadFile](/apps-plugin/docs/js-api/network/uploadFile.md): 上传本地文件,并返回可用于监听进度和中断上传的 UploadTask。 - [callTool](/apps-plugin/docs/js-api/open/business/callTool.md): 调用当前应用的 Tool。 豆包会根据当前应用插件页面或会话 Widget 确定应用和版本,开发者只需传入 Tool 名称和参数。 Tool 正常结果通过 toolResult 返回,Tool 业务错误通过 toolError 返回,两者都会正常 resolve;调用前校验、鉴权或返回结构校验失败时 Promise reject。 - [createTask](/apps-plugin/docs/js-api/open/business/createTask.md): 创建任务。 - [expiredWidget](/apps-plugin/docs/js-api/open/business/expiredWidget.md): 更新过期的 Widget 为固定卡片。 - [getPrivacySetting](/apps-plugin/docs/js-api/open/business/getPrivacySetting.md): 获取隐私设置状态。 - [业务能力](/apps-plugin/docs/js-api/open/business/index.md): callTool createTask expiredWidget getPrivacySetting sendFollowUpMessage updateModelContext updateWidget - [sendFollowUpMessage](/apps-plugin/docs/js-api/open/business/sendFollowUpMessage.md): 以用户身份发送后续消息,触发新一轮对话、API 调用或引导模型响应。 - [updateModelContext](/apps-plugin/docs/js-api/open/business/updateModelContext.md): 向 Agent 捐赠上下文。 - [updateWidget](/apps-plugin/docs/js-api/open/business/updateWidget.md): 更新指定 Widget 卡片实例的渲染数据。 用于卡片内操作后刷新卡片展示、把服务端最新结果写回卡片,或由 Page 根据传入的 widgetInstanceId 更新原卡片;需要替换卡片类型时可同时传入新的 widgetId。 widgetData 与 toolResult 二选一。传入 toolResult 时不能切换 widgetId, 结构化结果必须符合当前应用的 Entity 协议。切换 widgetId 时不能关闭重新创建。 - [开放能力](/apps-plugin/docs/js-api/open/index.md): 登录 业务能力 支付 - [登录](/apps-plugin/docs/js-api/open/login/index.md): login loginWithDoubaoWidget postLoginResult - [login](/apps-plugin/docs/js-api/open/login/login.md): 获取当前豆包用户的一次性登录凭证。 - [loginWithDoubaoWidget](/apps-plugin/docs/js-api/open/login/loginWithDoubaoWidget.md): 在 Widget 中拉起平台登录和隐私协议授权交互。 - [postLoginResult](/apps-plugin/docs/js-api/open/login/postLoginResult.md): 向豆包回传三方 MCP 授权登录结果。 - [createSignOrder](/apps-plugin/docs/js-api/open/payment/createSignOrder.md): 创建三方纯签约流程所需的签约单。 - [dypay](/apps-plugin/docs/js-api/open/payment/dypay.md): 发起抖音支付流程。 - [getOrderPayment](/apps-plugin/docs/js-api/open/payment/getOrderPayment.md): 使用预下单返回的平台交易订单号拉起用户收银台。 - [getOrderPaymentWithSign](/apps-plugin/docs/js-api/open/payment/getOrderPaymentWithSign.md): 使用预下单号和签约参数拉起支付并签约收银台。 - [支付](/apps-plugin/docs/js-api/open/payment/index.md): createSignOrder dypay getOrderPayment getOrderPaymentWithSign requestOrder sign - [requestOrder](/apps-plugin/docs/js-api/open/payment/requestOrder.md): 交易预下单,获取拉起收银台所需的平台交易订单号。 - [sign](/apps-plugin/docs/js-api/open/payment/sign.md): 使用三方纯签约的签约单号拉起用户签约页面。 - [exitApp](/apps-plugin/docs/js-api/router/exitApp.md): 退出当前所有页面。 - [路由](/apps-plugin/docs/js-api/router/index.md): exitApp navigateBack navigateTo navigateToDouyinMiniProgram openPage openPageInChat redirectTo reLaunch - [navigateBack](/apps-plugin/docs/js-api/router/navigateBack.md): 关闭当前页面,返回上一页面或多级页面。 - [navigateTo](/apps-plugin/docs/js-api/router/navigateTo.md): 保留当前页面,跳转到应用内的某个页面。 - [navigateToDouyinMiniProgram](/apps-plugin/docs/js-api/router/navigateToDouyinMiniProgram.md): 在豆包内打开指定版本的抖音应用插件。 - [openPage](/apps-plugin/docs/js-api/router/openPage.md): 打开应用内页面。 在主对话流卡片中调用时会重新打开全页并忽略 mode;在全页或全页内 Chat UI 的卡片中调用时按照 mode 操作页面栈。 - [openPageInChat](/apps-plugin/docs/js-api/router/openPageInChat.md): 在当前关联的主对话流中以半屏形式打开应用内页面。 调用后不会创建或操作全页页面栈。需要进入全页应用插件或操作已有页面栈时,请使用 openPage。 - [reLaunch](/apps-plugin/docs/js-api/router/reLaunch.md): 关闭所有页面并跳转到应用内页面。 - [redirectTo](/apps-plugin/docs/js-api/router/redirectTo.md): 关闭当前页面,跳转到应用内的某个页面。 - [clearStorage](/apps-plugin/docs/js-api/storage/clearStorage.md): 清空本地缓存。 - [clearStorageSync](/apps-plugin/docs/js-api/storage/clearStorageSync.md): 清空本地缓存。 - [getStorage](/apps-plugin/docs/js-api/storage/getStorage.md): 从本地缓存读取数据。 - [getStorageInfo](/apps-plugin/docs/js-api/storage/getStorageInfo.md): 获取本地缓存信息。 - [getStorageInfoSync](/apps-plugin/docs/js-api/storage/getStorageInfoSync.md): 同步获取本地缓存信息。 - [getStorageSync](/apps-plugin/docs/js-api/storage/getStorageSync.md): 从本地缓存同步读取数据。 - [存储](/apps-plugin/docs/js-api/storage/index.md): clearStorage clearStorageSync getStorage getStorageInfo getStorageInfoSync getStorageSync removeStorage removeStorageSync setStorage setStorageSync - [removeStorage](/apps-plugin/docs/js-api/storage/removeStorage.md): 删除本地缓存中指定 key 的数据。 - [removeStorageSync](/apps-plugin/docs/js-api/storage/removeStorageSync.md): 删除本地缓存中指定 key 的数据。 - [setStorage](/apps-plugin/docs/js-api/storage/setStorage.md): 将数据写入本地缓存。 - [setStorageSync](/apps-plugin/docs/js-api/storage/setStorageSync.md): 将数据写入本地缓存。 - [界面](/apps-plugin/docs/js-api/ui/index.md): 交互 输入 - [hideKeyboard](/apps-plugin/docs/js-api/ui/input/hideKeyboard.md): 收起当前键盘。 - [输入](/apps-plugin/docs/js-api/ui/input/index.md): hideKeyboard onKeyboardHeightChange - [onKeyboardHeightChange](/apps-plugin/docs/js-api/ui/input/onKeyboardHeightChange.md): 监听键盘高度变化事件。 - [disableAlertBeforeUnload](/apps-plugin/docs/js-api/ui/interaction/disableAlertBeforeUnload.md): 关闭页面返回前提醒。 - [enableAlertBeforeUnload](/apps-plugin/docs/js-api/ui/interaction/enableAlertBeforeUnload.md): 开启页面返回前提醒。 当用户在应用插件的非最底层页面点击左上角返回按钮、左上角首页按钮或客户端返回键时,弹起询问弹窗 返回询问对话框只会对调用的当前页面生效,通过手势滑动返回时不会弹起询问对话框 - [getMenuButtonBoundingClientRect](/apps-plugin/docs/js-api/ui/interaction/getMenuButtonBoundingClientRect.md): 取菜单按钮(右上角胶囊按钮)的布局位置信息。 - [hideLoading](/apps-plugin/docs/js-api/ui/interaction/hideLoading.md): 隐藏当前 loading。 - [hideToast](/apps-plugin/docs/js-api/ui/interaction/hideToast.md): 隐藏当前 Toast。 - [交互](/apps-plugin/docs/js-api/ui/interaction/index.md): disableAlertBeforeUnload enableAlertBeforeUnload getMenuButtonBoundingClientRect hideLoading hideToast showActionSheet showBottomSheet showLoading showModal showToast - [showActionSheet](/apps-plugin/docs/js-api/ui/interaction/showActionSheet.md): 显示操作菜单。 - [showBottomSheet](/apps-plugin/docs/js-api/ui/interaction/showBottomSheet.md): 显示豆包底部弹窗。 - [showLoading](/apps-plugin/docs/js-api/ui/interaction/showLoading.md): 显示 loading 提示框。 - [showModal](/apps-plugin/docs/js-api/ui/interaction/showModal.md): 显示模态对话框。 - [showToast](/apps-plugin/docs/js-api/ui/interaction/showToast.md): 显示 Toast 提示。 - [卡片相关 API](/apps-plugin/docs/server-api/card.md): 阅读提示:本文介绍豆包应用插件卡片相关的服务端 API。当前提供「刷新卡片实例」接口,用于在卡片下发后主动更新卡片数据。后续会陆续开放更多卡片操作接口。 - [服务端 API 参考](/apps-plugin/docs/server-api/index.md): 服务端 API 总览 登录相关 API 支付相关 API 卡片相关 API - [登录相关 API](/apps-plugin/docs/server-api/login.md): 阅读提示:本文是登录 OpenAPI 的接口字典,适合查询字段和示例。如果你还不清楚端侧如何取得 login_code、phone_code,或服务端如何完成账号绑定,请先阅读 登录接入(服务端)。 目标 调用顺序 服务端鉴权方式 返回结果 仅获取用户标识 直接使用 login_code 调用“获取用户 OpenID” 请求体传 app_id 和 app_secret,不需要应用级 Token open_id 获取用户手机号 先获取应用级 Token,再使用 phone_code 调用“获取用户加密手机号” 请求头传 x-DB-AccessToken encrypt_phone_number 密文 调用其他应用级 OpenAPI 先获取应用级 Token,再按目标接口要求调用 请求头传应用级 Token 以目标接口为准 login_code 和 phone_code 都是短时、一次性的端侧票据,服务端收到后应立即兑换。手机号密文必须在服务端解密;证书与解密方法参见 关于证书。 - [服务端 API 总览](/apps-plugin/docs/server-api/overview.md): 当豆包应用插件需要识别用户、处理支付订单、更新进行中任务或发送服务通知时,你的服务端可以调用豆包开放平台提供的服务端 API。 这些 API 应由你的后端服务调用,不应由应用插件前端直接调用。AppSecret、访问令牌、刷新令牌和支付私钥等敏感信息只能保存在服务端,不要写入前端源码、Manifest、Skill 或公开的代码仓库。 - [支付相关 API](/apps-plugin/docs/server-api/payment.md): 本文提供豆包应用插件支付服务端 API 的请求参数、响应字段、状态枚举、回调协议、签名规则和支付错误码参考。 如果你还没有完成商户开户、应用绑定和证书配置,请先阅读《支付接入(服务端)》。服务端 API 的请求域名、应用级 Access Token 获取方式、通用响应结构和通用重试原则,参见《服务端 API 总览》。 - [AI 开发](/apps-plugin/docs/skill-development/index.md): MCP Server 开发 MCP Server 协议规范 Skill 开发 - [问询卡](/apps-plugin/docs/templates/ask-human-card.md): AskHumanCard 是展示在回答气泡内的一组选项按钮,适合流程需要用户主动确认选择或执行固定跳转的场景。 AskHumanCard 问询卡效果 - [确认订单卡](/apps-plugin/docs/templates/checkout-card.md): CheckoutCard 用于承载商品或服务的订单信息和后续操作,适合交易前的订单核对、下单确认和支付确认。 CheckoutCard 确认订单卡效果 - [组合卡](/apps-plugin/docs/templates/composite-card.md): CompositeCard 用于一个完整业务语义需要组合多个模板模块,或需要定制内容区、但没有完全匹配的专用模板时。它管理标准卡片外壳、标题栏和底部操作区;内容区可以按顺序组合行程、内容列表、选项组或业务组件。 - [信息卡](/apps-plugin/docs/templates/content-card.md): ContentCard 用于承载单项或多项通用信息,由标题栏、列表内容和底部操作区组成。每个列表项可以包含图片、标题、描述和操作控件,适合展示商品、服务或内容入口。 ContentCard 信息卡效果 - [券卡](/apps-plugin/docs/templates/coupon-card.md): CouponCard 展示优惠券金额、门槛、来源及使用操作,通过 items 数量自动选择布局。 - [卡片模板](/apps-plugin/docs/templates/index.md): 卡片模板把 MCP Tool 返回的结构化结果,渲染成豆包对话流中符合设计规范的卡片。@doubao-dev/template 已经把标题栏、内容区和操作区组合成完整结构;在 Widget 中选择合适的模板并传入业务数据即可,无需从头编写卡片布局。 设计稿:豆包应用插件组件库 - [地图卡](/apps-plugin/docs/templates/map-card.md): MapCard 用于展示路线预估、叫车状态和位置详情,由固定高度地图、可选信息区和操作区组成。地图覆盖物通过 mapProps 配置,卡片统一管理地图尺寸和卡片结构。 - [价格操作卡](/apps-plugin/docs/templates/price-action-card.md): PriceActionCard 用于承载单项或多项价格信息与后续操作,适合报价、权益和服务方案等结果展示。 PriceActionCard 价格操作卡效果 - [共享组件规范](/apps-plugin/docs/templates/shared-components.md): 本页汇总卡片模板共用的内容与交互规范,并在文末说明公开 Primitives 的用法。设计约束不等于新增 Props;开发时以各模板页面和当前安装版本导出的 TypeScript 类型为准。 - [交通列表卡](/apps-plugin/docs/templates/transit-card.md): TransitCard 用于展示航班、列车、大巴等交通票务方案。每个列表项由标题、出发信息、中转信息、到达信息和价格组成。 TransitCard 交通列表卡效果 ## 提审发布 - [打包与提审](/apps-plugin/docs/release/package-and-submit.md): 本文介绍如何使用 dbx 校验项目、创建测试或正式版本,以及如何查询云构建结果。 完整流程如下: flowchart LR A[检查项目配置] --> B[校验 manifest.yaml] B --> C[打包并上传] C --> D[等待云构建] D --> E{构建结果} E -->|失败| F[修复问题并重新上传] F --> C E -->|成功| G[打包与云构建完成] - [审核标准](/apps-plugin/docs/release/review-guidelines.md): :::info 提示 本指南面向豆包开发者平台的对接开发者,帮助你在提交应用插件审核前理解审核标准、提前规避常见驳回原因,并在收到审核报告后快速完成整改与复审。审核是应用插件上线前的"准出闸门",只有通过审核的版本才能进入内测、灰测直至上线。 ::: - [内测与上线](/apps-plugin/docs/release/beta-and-launch.md): :::info 提示 审核通过(reviewed)后,版本还不会直接对所有人开放,而是先进入内测:只让一批你指定的用户提前体验,用真实使用场景做最后一轮验证,确认没问题再上线。 ::: - [打包、提审与发布](/apps-plugin/docs/release/index.md): 打包与提审 审核标准 内测与上线 ## 平台资源 - [支付方案介绍](/apps-plugin/docs/payment-legal/payment.md) - [开发者协议与政策](/apps-plugin/docs/payment-legal/agreements.md): 可下载以下文档。如有问题,可联系 BD 同学处理。 模板-豆包小程序合作协议 260708.docx - [联系与支持](/apps-plugin/docs/resources/contact.md): :::info 提示 使用开发者平台时遇到问题、需要帮助或想反馈建议,都可以通过控制台的「开发者助手」联系我们。 它提供 AI 智能应答、工单提交与查看功能,AI 智能应答已内置全部开发者文档,可以快速准确地解答大部分问题;如有AI 智能应答无法处理的问题或者对平台的额外需求,都可以提交工单,有专门负责的产研同学解答。二者结合的整体响应速度会大大快于文档沟通。 我们后续会不断优化开发者助手的体验(包括延时、交互等)。 ::: - [基础库版本](/apps-plugin/docs/resources/base-library-versions.md): 查询豆包客户端基础库版本与客户端版本号的对应关系,了解 SDKVersion 和 version 字段的含义,以及通过 getAppBaseInfoSync 获取当前运行环境版本的方法。 - [更新日志](/apps-plugin/docs/resources/changelog.md) - [支付方案与法务协议](/apps-plugin/docs/payment-legal/index.md) - [平台资源](/apps-plugin/docs/resources/index.md)