@doubao-apps/ai 0.0.32 → 0.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/733.js +41 -0
- package/dist/cli.js +1 -1
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/README.md +0 -32
- package/dist/contexts/doubao-apps-dev/references/reference/open-api.md +1 -366
- package/dist/index.js +1 -1
- package/dist/manifest.json +2 -2
- package/dist/skills/doubao-apps-dev/SKILL.md +4 -5
- package/dist/skills/doubao-apps-dev/references/reference/open-api/README.md +0 -32
- package/dist/skills/doubao-apps-dev/references/reference/open-api.md +1 -366
- package/dist/skills/h5-to-doubao/SKILL.md +1 -1
- package/package.json +1 -1
- package/dist/994.js +0 -41
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +0 -536
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/02-/345/256/232/344/275/215.md +0 -359
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/03-/345/255/230/345/202/250.md +0 -409
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/04-/350/267/257/347/224/261.md +0 -165
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/05-/347/225/214/351/235/242-/344/272/244/344/272/222.md +0 -432
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/06-/347/225/214/351/235/242-/350/276/223/345/205/245.md +0 -72
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/07-/347/275/221/347/273/234.md +0 -468
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/08-/345/252/222/344/275/223.md +0 -346
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/09-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md +0 -1238
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/10-/346/225/260/346/215/256/345/210/206/346/236/220.md +0 -67
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/11-/350/256/276/345/244/207-/350/223/235/347/211/231.md +0 -961
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/12-/350/256/276/345/244/207-wi-fi.md +0 -311
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/13-/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md +0 -104
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/14-/350/256/276/345/244/207-ibeacon.md +0 -148
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/15-/350/256/276/345/244/207-/347/275/227/347/233/230.md +0 -82
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/16-/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md +0 -104
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/17-/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md +0 -104
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/18-ui-/350/276/223/345/205/245.md +0 -49
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207-/347/275/221/347/273/234.md +0 -164
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/20-/350/256/276/345/244/207-/347/237/255/344/277/241.md +0 -62
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/21-/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md +0 -43
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/22-/350/256/276/345/244/207-/345/237/272/347/241/200/344/277/241/346/201/257.md +0 -133
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/23-/350/256/276/345/244/207-/347/224/265/346/261/240.md +0 -83
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/24-/350/256/276/345/244/207-/346/227/245/345/216/206.md +0 -215
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/25-/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md +0 -70
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/26-/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md +0 -270
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/27-/350/256/276/345/244/207-/345/212/240/345/257/206.md +0 -56
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/28-/350/256/276/345/244/207-/347/224/265/350/257/235.md +0 -41
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/29-/350/256/276/345/244/207-/346/211/253/347/240/201.md +0 -100
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/30-/350/256/276/345/244/207-/345/261/217/345/271/225.md +0 -173
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/31-/350/256/276/345/244/207-/351/234/207/345/212/250.md +0 -66
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/32-/346/226/207/344/273/266/347/263/273/347/273/237.md +0 -1043
- package/dist/skills/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +0 -536
- package/dist/skills/doubao-apps-dev/references/reference/open-api/02-/345/256/232/344/275/215.md +0 -359
- package/dist/skills/doubao-apps-dev/references/reference/open-api/03-/345/255/230/345/202/250.md +0 -409
- package/dist/skills/doubao-apps-dev/references/reference/open-api/04-/350/267/257/347/224/261.md +0 -165
- package/dist/skills/doubao-apps-dev/references/reference/open-api/05-/347/225/214/351/235/242-/344/272/244/344/272/222.md +0 -432
- package/dist/skills/doubao-apps-dev/references/reference/open-api/06-/347/225/214/351/235/242-/350/276/223/345/205/245.md +0 -72
- package/dist/skills/doubao-apps-dev/references/reference/open-api/07-/347/275/221/347/273/234.md +0 -468
- package/dist/skills/doubao-apps-dev/references/reference/open-api/08-/345/252/222/344/275/223.md +0 -346
- package/dist/skills/doubao-apps-dev/references/reference/open-api/09-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md +0 -1238
- package/dist/skills/doubao-apps-dev/references/reference/open-api/10-/346/225/260/346/215/256/345/210/206/346/236/220.md +0 -67
- package/dist/skills/doubao-apps-dev/references/reference/open-api/11-/350/256/276/345/244/207-/350/223/235/347/211/231.md +0 -961
- package/dist/skills/doubao-apps-dev/references/reference/open-api/12-/350/256/276/345/244/207-wi-fi.md +0 -311
- package/dist/skills/doubao-apps-dev/references/reference/open-api/13-/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md +0 -104
- package/dist/skills/doubao-apps-dev/references/reference/open-api/14-/350/256/276/345/244/207-ibeacon.md +0 -148
- package/dist/skills/doubao-apps-dev/references/reference/open-api/15-/350/256/276/345/244/207-/347/275/227/347/233/230.md +0 -82
- package/dist/skills/doubao-apps-dev/references/reference/open-api/16-/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md +0 -104
- package/dist/skills/doubao-apps-dev/references/reference/open-api/17-/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md +0 -104
- package/dist/skills/doubao-apps-dev/references/reference/open-api/18-ui-/350/276/223/345/205/245.md +0 -49
- package/dist/skills/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207-/347/275/221/347/273/234.md +0 -164
- package/dist/skills/doubao-apps-dev/references/reference/open-api/20-/350/256/276/345/244/207-/347/237/255/344/277/241.md +0 -62
- package/dist/skills/doubao-apps-dev/references/reference/open-api/21-/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md +0 -43
- package/dist/skills/doubao-apps-dev/references/reference/open-api/22-/350/256/276/345/244/207-/345/237/272/347/241/200/344/277/241/346/201/257.md +0 -133
- package/dist/skills/doubao-apps-dev/references/reference/open-api/23-/350/256/276/345/244/207-/347/224/265/346/261/240.md +0 -83
- package/dist/skills/doubao-apps-dev/references/reference/open-api/24-/350/256/276/345/244/207-/346/227/245/345/216/206.md +0 -215
- package/dist/skills/doubao-apps-dev/references/reference/open-api/25-/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md +0 -70
- package/dist/skills/doubao-apps-dev/references/reference/open-api/26-/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md +0 -270
- package/dist/skills/doubao-apps-dev/references/reference/open-api/27-/350/256/276/345/244/207-/345/212/240/345/257/206.md +0 -56
- package/dist/skills/doubao-apps-dev/references/reference/open-api/28-/350/256/276/345/244/207-/347/224/265/350/257/235.md +0 -41
- package/dist/skills/doubao-apps-dev/references/reference/open-api/29-/350/256/276/345/244/207-/346/211/253/347/240/201.md +0 -100
- package/dist/skills/doubao-apps-dev/references/reference/open-api/30-/350/256/276/345/244/207-/345/261/217/345/271/225.md +0 -173
- package/dist/skills/doubao-apps-dev/references/reference/open-api/31-/350/256/276/345/244/207-/351/234/207/345/212/250.md +0 -66
- package/dist/skills/doubao-apps-dev/references/reference/open-api/32-/346/226/207/344/273/266/347/263/273/347/273/237.md +0 -1043
package/dist/733.js
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import l,{createRequire as e}from"node:module";let o=l.createRequire(import.meta.url);import{__webpack_require__ as t}from"./rslib-runtime.js";import{fileURLToPath as s}from"node:url";import{dirname as a}from"node:path";let i=e(import.meta.url);t.add({"node:fs"(l){l.exports=i("node:fs")},"node:path"(l){l.exports=i("node:path")},"../../ai/dist/cli.js"(l,e,t){var i=a(s(import.meta.url));let n=t("node:fs"),r=t("node:path"),c={amp:{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},"kimi-cli":{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},replit:{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},universal:{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},antigravity:{projectPath:".agent/skills/",globalPath:"~/.gemini/antigravity/skills/"},augment:{projectPath:".augment/skills/",globalPath:"~/.augment/skills/"},claude:{projectPath:".claude/skills/",globalPath:"~/.claude/skills/"},"claude-code":{projectPath:".claude/skills/",globalPath:"~/.claude/skills/"},openclaw:{projectPath:"skills/",globalPath:"~/.openclaw/skills/"},cline:{projectPath:".agents/skills/",globalPath:"~/.agents/skills/"},codebuddy:{projectPath:".codebuddy/skills/",globalPath:"~/.codebuddy/skills/"},codex:{projectPath:".agents/skills/",globalPath:"~/.codex/skills/"},"command-code":{projectPath:".commandcode/skills/",globalPath:"~/.commandcode/skills/"},continue:{projectPath:".continue/skills/",globalPath:"~/.continue/skills/"},cortex:{projectPath:".cortex/skills/",globalPath:"~/.snowflake/cortex/skills/"},crush:{projectPath:".crush/skills/",globalPath:"~/.config/crush/skills/"},cursor:{projectPath:".agents/skills/",globalPath:"~/.cursor/skills/"},droid:{projectPath:".factory/skills/",globalPath:"~/.factory/skills/"},"gemini-cli":{projectPath:".agents/skills/",globalPath:"~/.gemini/skills/"},"github-copilot":{projectPath:".agents/skills/",globalPath:"~/.copilot/skills/"},goose:{projectPath:".goose/skills/",globalPath:"~/.config/goose/skills/"},junie:{projectPath:".junie/skills/",globalPath:"~/.junie/skills/"},"iflow-cli":{projectPath:".iflow/skills/",globalPath:"~/.iflow/skills/"},kilo:{projectPath:".kilocode/skills/",globalPath:"~/.kilocode/skills/"},"kiro-cli":{projectPath:".kiro/skills/",globalPath:"~/.kiro/skills/"},kode:{projectPath:".kode/skills/",globalPath:"~/.kode/skills/"},mcpjam:{projectPath:".mcpjam/skills/",globalPath:"~/.mcpjam/skills/"},"mistral-vibe":{projectPath:".vibe/skills/",globalPath:"~/.vibe/skills/"},mux:{projectPath:".mux/skills/",globalPath:"~/.mux/skills/"},opencode:{projectPath:".agents/skills/",globalPath:"~/.config/opencode/skills/"},openhands:{projectPath:".openhands/skills/",globalPath:"~/.openhands/skills/"},pi:{projectPath:".pi/skills/",globalPath:"~/.pi/agent/skills/"},qoder:{projectPath:".qoder/skills/",globalPath:"~/.qoder/skills/"},"qwen-code":{projectPath:".qwen/skills/",globalPath:"~/.qwen/skills/"},roo:{projectPath:".roo/skills/",globalPath:"~/.roo/skills/"},trae:{projectPath:".trae/skills/",globalPath:"~/.trae/skills/"},"trae-cn":{projectPath:".trae/skills/",globalPath:"~/.trae-cn/skills/"},windsurf:{projectPath:".windsurf/skills/",globalPath:"~/.codeium/windsurf/skills/"},zencoder:{projectPath:".zencoder/skills/",globalPath:"~/.zencoder/skills/"},neovate:{projectPath:".neovate/skills/",globalPath:"~/.neovate/skills/"},pochi:{projectPath:".pochi/skills/",globalPath:"~/.pochi/skills/"},adal:{projectPath:".adal/skills/",globalPath:"~/.adal/skills/"}};function d(){try{let l=o.resolve("@byted-doubao-apps/ai-assets/manifest");return r.dirname(l)}catch{return r.join(i,"..","dist")}}function g(){return r.join(d(),"skills")}function k(l){return l.startsWith("~/")?r.join(process.env.HOME||process.env.USERPROFILE||"",l.slice(2)):l}function p(l,e){if(!n.existsSync(l))throw Error(`Source directory not found: ${l}`);for(let o of(n.mkdirSync(e,{recursive:!0}),n.readdirSync(l,{withFileTypes:!0}))){let t=r.join(l,o.name),s=r.join(e,o.name);o.isDirectory()?p(t,s):n.copyFileSync(t,s)}}function u(l){let e={agent:null,global:!1};for(let o=0;o<l.length;o++)("--agent"===l[o]||"-a"===l[o])&&l[o+1]?e.agent=l[++o]:("--global"===l[o]||"-g"===l[o])&&(e.global=!0);return e}function h(l){let e=r.join(r.join(d(),"contexts"),"doubao-apps-dev"),o=process.cwd();if(!n.existsSync(e))throw Error(`Knowledge source not found. Run build first: ${e}`);let t=r.join(e,"AGENTS.md");n.existsSync(t)&&(n.copyFileSync(t,r.join(o,"AGENTS.md")),console.log(" ✓ AGENTS.md"));let s=r.join(e,"references");if(n.existsSync(s)&&(p(s,r.join(o,"references")),console.log(" ✓ references/")),"claude"===l){let l=r.join(e,"CLAUDE.md");n.existsSync(l)&&(n.copyFileSync(l,r.join(o,"CLAUDE.md")),console.log(" ✓ CLAUDE.md"))}console.log("\nAI context installed successfully.")}function P(l,e,o){if(!c[e])throw Error(`Unknown agent: "${e}". Supported agents: ${Object.keys(c).join(", ")}`);let t=r.join(g(),l);if(!n.existsSync(t)){let e=g(),o=n.existsSync(e)?n.readdirSync(e).join(", "):"(none)";throw Error(`Skill "${l}" not found. Available skills: ${o}`)}let s=c[e],a=o?s.globalPath:s.projectPath,i=o?r.join(k(a),l):r.join(process.cwd(),a,l);for(let o of(console.log(`Installing skill "${l}" for ${e}...`),console.log(` Target: ${i}`),n.existsSync(i)&&n.rmSync(i,{recursive:!0,force:!0}),n.mkdirSync(i,{recursive:!0}),n.readdirSync(t,{withFileTypes:!0}))){let l=r.join(t,o.name),e=r.join(i,o.name);o.isDirectory()?(p(l,e),console.log(` ✓ ${o.name}/`)):(n.copyFileSync(l,e),console.log(` ✓ ${o.name}`))}console.log(" ✓ Done")}l.exports={runCli:function(l={}){let e=l.commandName||"doubao-ai",[o,...t]=process.argv.slice(2);if(!o||"--help"===o||"-h"===o)return void console.log(`
|
|
2
|
+
${e} - Doubao Apps SDK AI 工具
|
|
3
|
+
|
|
4
|
+
用法:
|
|
5
|
+
${e} add context [--agent <agent>] 安装 AI 上下文到当前项目
|
|
6
|
+
${e} update context 更新已安装的 AI 上下文
|
|
7
|
+
${e} skills add <skill1> [skill2...] --agent <agent> 安装一个或多个 skill 到指定 Agent
|
|
8
|
+
${e} skills list 查看可用 skills
|
|
9
|
+
${e} skills update [--global] 更新所有已安装的 skills
|
|
10
|
+
|
|
11
|
+
选项:
|
|
12
|
+
--agent <agent> 指定 AI Agent(如 claude、claude-code、cursor)
|
|
13
|
+
--global, -g 全局安装(用户目录而非项目目录)
|
|
14
|
+
|
|
15
|
+
示例:
|
|
16
|
+
# 安装 AI 上下文(通用)
|
|
17
|
+
${e} add context
|
|
18
|
+
|
|
19
|
+
# 安装 AI 上下文(Claude 专用,额外生成 CLAUDE.md)
|
|
20
|
+
${e} add context --agent claude
|
|
21
|
+
|
|
22
|
+
# 更新已安装的 AI 上下文
|
|
23
|
+
${e} update context
|
|
24
|
+
|
|
25
|
+
# 安装一个或多个 skill 到 Claude Code
|
|
26
|
+
${e} skills add doubao-apps-dev quality-gate --agent claude-code
|
|
27
|
+
|
|
28
|
+
# 全局安装 skill
|
|
29
|
+
${e} skills add doubao-apps-dev --agent claude-code --global
|
|
30
|
+
|
|
31
|
+
# 查看可用 skills
|
|
32
|
+
${e} skills list
|
|
33
|
+
|
|
34
|
+
# 更新所有已安装的 skills
|
|
35
|
+
${e} skills update
|
|
36
|
+
|
|
37
|
+
支持的 Agents:
|
|
38
|
+
${Object.keys(c).join(", ")}
|
|
39
|
+
`);if("add"===o){let[l,...e]=t;"context"!==l&&(console.error(`Unknown target: "${l}". Supported: context`),process.exit(1));let{agent:o}=u(e);console.log(`Installing AI context${o?` (--agent ${o})`:""}...`),h(o);return}if("update"===o){let l,o,s,[a]=t;"context"!==a&&(console.error(`Unknown target: "${a}". Supported: context`),process.exit(1)),l=process.cwd(),o=n.existsSync(r.join(l,"AGENTS.md")),s=n.existsSync(r.join(l,"CLAUDE.md")),o||s?(console.log("Updating knowledge base..."),h(s?"claude":null)):console.log(`No AI context found in current directory. Run \`${e} add context\` first.`);return}if("skills"===o){let[l,...o]=t;if("list"===l)return void function(){let l=g();if(!n.existsSync(l))return console.log("No skills available. Run build first.");let e=n.readdirSync(l,{withFileTypes:!0}).filter(l=>l.isDirectory()).map(l=>l.name);if(0===e.length)return console.log("No skills available.");for(let o of(console.log("Available skills:"),e)){let e=r.join(l,o,"SKILL.md");console.log(` - ${o}${n.existsSync(e)?"":" (not built)"}`)}}();if("add"===l){let{agent:l,global:t}=u(o),s=[];for(let l=0;l<o.length;l++){let e=o[l];if("--agent"===e||"-a"===e)l++;else{if("--global"===e||"-g"===e)continue;s.push(e)}}for(let o of(0===s.length&&(console.error(`Usage: ${e} skills add <skill-name>... --agent <agent>`),process.exit(1)),l||(console.error(`--agent is required. Example: ${e} skills add doubao-apps-dev --agent claude-code`),process.exit(1)),s))P(o,l,t);return}if("update"===l){let{global:l}=u(o);!function(l){let e=g();if(!n.existsSync(e))return console.log("No skills to update. Run build first.");let o=n.readdirSync(e,{withFileTypes:!0}).filter(l=>l.isDirectory()).map(l=>l.name),t=0;for(let[e,s]of Object.entries(c)){let a=l?s.globalPath:s.projectPath,i=l?k(a):r.join(process.cwd(),a);for(let s of o)n.existsSync(r.join(i,s))&&(P(s,e,l),t++)}0===t?console.log("No installed skills found to update."):console.log(`
|
|
40
|
+
Updated ${t} skill installation(s).`)}(l);return}console.error(`Unknown skills subcommand: "${l}". Use: add, list, update`),process.exit(1)}console.error(`Unknown command: "${o}". Run \`${e} --help\` for usage.`),process.exit(1)}}}});
|
|
41
|
+
//# sourceMappingURL=733.js.map
|
package/dist/cli.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import"node:module";import{__webpack_require__ as
|
|
1
|
+
import"node:module";import{__webpack_require__ as o}from"./rslib-runtime.js";import"./733.js";(0,o("../../ai/dist/cli.js").runCli)({commandName:"doubao-cli"});
|
|
2
2
|
//# sourceMappingURL=cli.js.map
|
|
@@ -6,35 +6,3 @@
|
|
|
6
6
|
|
|
7
7
|
| 分组 | 说明 | API 数量 | 详细文档 |
|
|
8
8
|
| --- | --- | ---: | --- |
|
|
9
|
-
| 基础 / 账号 / 系统 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 | 9 | [查看](./01-基础-账号-系统.md) |
|
|
10
|
-
| 定位 | 获取设备当前的地理位置信息。 | 9 | [查看](./02-定位.md) |
|
|
11
|
-
| 存储 | 本地缓存;带 Sync 后缀的是同步 API。 | 10 | [查看](./03-存储.md) |
|
|
12
|
-
| 路由 | 应用内页面跳转、返回、退出和关闭。 | 6 | [查看](./04-路由.md) |
|
|
13
|
-
| 界面 / 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./05-界面-交互.md) |
|
|
14
|
-
| 界面 / 输入 | 键盘和输入框选区能力。 | 2 | [查看](./06-界面-输入.md) |
|
|
15
|
-
| 网络 | 网络请求与 WebSocket。 | 2 | [查看](./07-网络.md) |
|
|
16
|
-
| 媒体 | 图片选择、预览、保存、压缩和信息读取。 | 5 | [查看](./08-媒体.md) |
|
|
17
|
-
| 开放能力 / 业务能力 | 开放业务能力、支付、隐私设置、上下文和外部应用打开。 | 20 | [查看](./09-开放能力-业务能力.md) |
|
|
18
|
-
| 数据分析 | 监控上报、事件和数据分析上报。 | 1 | [查看](./10-数据分析.md) |
|
|
19
|
-
| 设备 / 蓝牙 | 蓝牙和 BLE 能力;通常先打开适配器,再扫描、连接和读写。 | 19 | [查看](./11-设备-蓝牙.md) |
|
|
20
|
-
| 设备 / Wi-Fi | Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。 | 7 | [查看](./12-设备-wi-fi.md) |
|
|
21
|
-
| 设备 / 加速度计 | 加速度计监听能力。 | 3 | [查看](./13-设备-加速度计.md) |
|
|
22
|
-
| 设备 / iBeacon | iBeacon 搜索和结果读取能力。 | 3 | [查看](./14-设备-ibeacon.md) |
|
|
23
|
-
| 设备 / 罗盘 | 罗盘监听能力。 | 3 | [查看](./15-设备-罗盘.md) |
|
|
24
|
-
| 设备 / 设备方向 | 设备方向监听能力。 | 3 | [查看](./16-设备-设备方向.md) |
|
|
25
|
-
| 设备 / 陀螺仪 | 陀螺仪监听能力。 | 3 | [查看](./17-设备-陀螺仪.md) |
|
|
26
|
-
| UI / 输入 | 键盘和输入框选区能力。 | 1 | [查看](./18-ui-输入.md) |
|
|
27
|
-
| 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./19-设备-网络.md) |
|
|
28
|
-
| 设备 / 短信 | 拉起系统短信发送面板。 | 1 | [查看](./20-设备-短信.md) |
|
|
29
|
-
| 设备 / 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./21-设备-无障碍.md) |
|
|
30
|
-
| 设备 / 基础信息 | 设备品牌、型号、系统、内存和性能等级。 | 2 | [查看](./22-设备-基础信息.md) |
|
|
31
|
-
| 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./23-设备-电池.md) |
|
|
32
|
-
| 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./24-设备-日历.md) |
|
|
33
|
-
| 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./25-设备-剪贴板.md) |
|
|
34
|
-
| 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./26-设备-联系人.md) |
|
|
35
|
-
| 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./27-设备-加密.md) |
|
|
36
|
-
| 设备 / 电话 | 拨打电话。 | 1 | [查看](./28-设备-电话.md) |
|
|
37
|
-
| 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./29-设备-扫码.md) |
|
|
38
|
-
| 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./30-设备-屏幕.md) |
|
|
39
|
-
| 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./31-设备-震动.md) |
|
|
40
|
-
| 文件系统 | 文件读写、目录管理和文件信息操作。 | 1 | [查看](./32-文件系统.md) |
|
|
@@ -2,375 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
> 公开可用的端能力 API。默认从 `@doubao-apps/framework/api` 导入;本文件根据 `packages/open-api/src` 的导出结构自动生成,按模块列出 API 名称和说明。
|
|
4
4
|
|
|
5
|
-
覆盖
|
|
5
|
+
覆盖 0 个函数。详细参数、返回值、示例和相关类型请查看 [Open API 目录](open-api/README.md),精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-apps/framework/api` 类型定义。
|
|
6
6
|
|
|
7
7
|
## 使用方式
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
10
|
import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
11
11
|
```
|
|
12
|
-
|
|
13
|
-
## 基础 / 账号 / 系统
|
|
14
|
-
|
|
15
|
-
账号、授权、宿主基础信息、窗口信息和能力可用性。
|
|
16
|
-
|
|
17
|
-
| API | 说明 |
|
|
18
|
-
| --- | --- |
|
|
19
|
-
| [getAccountInfo](open-api/01-基础-账号-系统.md#getaccountinfo) | 异步获取账号信息。 |
|
|
20
|
-
| [getAccountInfoSync](open-api/01-基础-账号-系统.md#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
|
|
21
|
-
| [authorize](open-api/01-基础-账号-系统.md#authorize) | 初始化授权。<br><br>按 scope 申请授权。 |
|
|
22
|
-
| [canIUse](open-api/01-基础-账号-系统.md#caniuse) | 检测当前宿主是否支持指定 API 或能力。<br><br>用于兼容性判断。 |
|
|
23
|
-
| [getWindowInfoSync](open-api/01-基础-账号-系统.md#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
|
|
24
|
-
| [getSystemSetting](open-api/01-基础-账号-系统.md#getsystemsetting) | 获取设备设置。 |
|
|
25
|
-
| [getAppBaseInfoSync](open-api/01-基础-账号-系统.md#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
|
|
26
|
-
| [getWindowInfo](open-api/01-基础-账号-系统.md#getwindowinfo) | 获取窗口信息。 |
|
|
27
|
-
| [getAppBaseInfo](open-api/01-基础-账号-系统.md#getappbaseinfo) | 获取应用基础信息。 |
|
|
28
|
-
|
|
29
|
-
## 定位
|
|
30
|
-
|
|
31
|
-
获取设备当前的地理位置信息。
|
|
32
|
-
|
|
33
|
-
| API | 说明 |
|
|
34
|
-
| --- | --- |
|
|
35
|
-
| [getLocation](open-api/02-定位.md#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
|
|
36
|
-
| [chooseLocation](open-api/02-定位.md#chooselocation) | 打开地图选择位置。 |
|
|
37
|
-
| [openLocation](open-api/02-定位.md#openlocation) | 使用地图查看位置。 |
|
|
38
|
-
| [startLocationUpdate](open-api/02-定位.md#startlocationupdate) | 开始接收位置更新。<br><br>需配对调用 stopLocationUpdate。 |
|
|
39
|
-
| [stopLocationUpdate](open-api/02-定位.md#stoplocationupdate) | 停止接收位置更新。 |
|
|
40
|
-
| [onLocationChange](open-api/02-定位.md#onlocationchange) | 注册地理位置变化回调。<br><br>返回 void,不是 Promise。 |
|
|
41
|
-
| [offLocationChange](open-api/02-定位.md#offlocationchange) | 取消注册地理位置变化回调。<br><br>返回 void,不是 Promise。 |
|
|
42
|
-
| [onLocationChangeError](open-api/02-定位.md#onlocationchangeerror) | 注册位置更新异常回调。<br><br>返回 void,不是 Promise。 |
|
|
43
|
-
| [offLocationChangeError](open-api/02-定位.md#offlocationchangeerror) | 取消注册位置更新异常回调。<br><br>返回 void,不是 Promise。 |
|
|
44
|
-
|
|
45
|
-
## 存储
|
|
46
|
-
|
|
47
|
-
本地缓存;带 Sync 后缀的是同步 API。
|
|
48
|
-
|
|
49
|
-
| API | 说明 |
|
|
50
|
-
| --- | --- |
|
|
51
|
-
| [setStorage](open-api/03-存储.md#setstorage) | 将数据写入本地缓存。 |
|
|
52
|
-
| [setStorageSync](open-api/03-存储.md#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
|
|
53
|
-
| [getStorage](open-api/03-存储.md#getstorage) | 从本地缓存读取数据。 |
|
|
54
|
-
| [getStorageSync](open-api/03-存储.md#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
|
|
55
|
-
| [removeStorage](open-api/03-存储.md#removestorage) | 删除本地缓存中指定 key 的数据。 |
|
|
56
|
-
| [removeStorageSync](open-api/03-存储.md#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
|
|
57
|
-
| [clearStorage](open-api/03-存储.md#clearstorage) | 清空本地缓存。 |
|
|
58
|
-
| [clearStorageSync](open-api/03-存储.md#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
|
|
59
|
-
| [getStorageInfo](open-api/03-存储.md#getstorageinfo) | 获取本地缓存信息。 |
|
|
60
|
-
| [getStorageInfoSync](open-api/03-存储.md#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
|
|
61
|
-
|
|
62
|
-
## 路由
|
|
63
|
-
|
|
64
|
-
应用内页面跳转、返回、退出和关闭。
|
|
65
|
-
|
|
66
|
-
| API | 说明 |
|
|
67
|
-
| --- | --- |
|
|
68
|
-
| [navigateTo](open-api/04-路由.md#navigateto) | 保留当前页面,跳转到应用内的某个页面。 |
|
|
69
|
-
| [redirectTo](open-api/04-路由.md#redirectto) | 关闭当前页面,跳转到应用内的某个页面。 |
|
|
70
|
-
| [reLaunch](open-api/04-路由.md#relaunch) | 关闭所有页面并跳转到应用内页面。 |
|
|
71
|
-
| [navigateBack](open-api/04-路由.md#navigateback) | 关闭当前页面,返回上一页面或多级页面。 |
|
|
72
|
-
| [exitApp](open-api/04-路由.md#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
|
|
73
|
-
| [close](open-api/04-路由.md#close) | 关闭栈顶页面。<br><br>已废弃,使用 navigateBack。 |
|
|
74
|
-
|
|
75
|
-
## 界面 / 交互
|
|
76
|
-
|
|
77
|
-
Toast、Loading、Modal、ActionSheet 和返回前提醒。
|
|
78
|
-
|
|
79
|
-
| API | 说明 |
|
|
80
|
-
| --- | --- |
|
|
81
|
-
| [showModal](open-api/05-界面-交互.md#showmodal) | 显示模态对话框。 |
|
|
82
|
-
| [showLoading](open-api/05-界面-交互.md#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
|
|
83
|
-
| [hideToast](open-api/05-界面-交互.md#hidetoast) | 隐藏当前 Toast。 |
|
|
84
|
-
| [hideLoading](open-api/05-界面-交互.md#hideloading) | 隐藏当前 loading。 |
|
|
85
|
-
| [showActionSheet](open-api/05-界面-交互.md#showactionsheet) | 显示操作菜单。 |
|
|
86
|
-
| [getMenuButtonBoundingClientRect](open-api/05-界面-交互.md#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
|
|
87
|
-
| [enableAlertBeforeUnload](open-api/05-界面-交互.md#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
|
|
88
|
-
| [disableAlertBeforeUnload](open-api/05-界面-交互.md#disablealertbeforeunload) | 关闭页面返回前提醒。 |
|
|
89
|
-
| [showToast](open-api/05-界面-交互.md#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
|
|
90
|
-
|
|
91
|
-
## 界面 / 输入
|
|
92
|
-
|
|
93
|
-
键盘和输入框选区能力。
|
|
94
|
-
|
|
95
|
-
| API | 说明 |
|
|
96
|
-
| --- | --- |
|
|
97
|
-
| [hideKeyboard](open-api/06-界面-输入.md#hidekeyboard) | 收起当前键盘。 |
|
|
98
|
-
| [onKeyboardHeightChange](open-api/06-界面-输入.md#onkeyboardheightchange) | 监听键盘高度变化事件。<br><br>返回取消监听函数。 |
|
|
99
|
-
|
|
100
|
-
## 网络
|
|
101
|
-
|
|
102
|
-
网络请求与 WebSocket。
|
|
103
|
-
|
|
104
|
-
| API | 说明 |
|
|
105
|
-
| --- | --- |
|
|
106
|
-
| [request](open-api/07-网络.md#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
|
|
107
|
-
| [connectSocket](open-api/07-网络.md#connectsocket) | 创建一个 WebSocket 连接,并返回可操作该连接的 SocketTask。<br><br>- 返回 SocketTask 不代表连接已经成功,连接成功以 onOpen 为准。 - send 必须接收对象参数,并把要发送的内容放在 data 字段中。 - 如果 protocols 非空,需要服务端支持并返回匹配的子协议。 - 多次调用会创建多条连接,旧连接不会自动关闭;不再使用时应主动调用 close。 - 连接失败、发送失败或关闭失败会通过 SocketTask.onError 通知。 |
|
|
108
|
-
|
|
109
|
-
## 媒体
|
|
110
|
-
|
|
111
|
-
图片选择、预览、保存、压缩和信息读取。
|
|
112
|
-
|
|
113
|
-
| API | 说明 |
|
|
114
|
-
| --- | --- |
|
|
115
|
-
| [saveImageToPhotosAlbum](open-api/08-媒体.md#saveimagetophotosalbum) | 保存图片到系统相册。 |
|
|
116
|
-
| [previewImage](open-api/08-媒体.md#previewimage) | 预览图片。 |
|
|
117
|
-
| [getImageInfo](open-api/08-媒体.md#getimageinfo) | 获取图片信息。 |
|
|
118
|
-
| [chooseImage](open-api/08-媒体.md#chooseimage) | 选择图片。 |
|
|
119
|
-
| [compressImage](open-api/08-媒体.md#compressimage) | 压缩图片。 |
|
|
120
|
-
|
|
121
|
-
## 开放能力 / 业务能力
|
|
122
|
-
|
|
123
|
-
开放业务能力、支付、隐私设置、上下文和外部应用打开。
|
|
124
|
-
|
|
125
|
-
| API | 说明 |
|
|
126
|
-
| --- | --- |
|
|
127
|
-
| [dispatchActionDirective](open-api/09-开放能力-业务能力.md#dispatchactiondirective) | 描述用户行为,约束模型行为并指定后续执行路径。<br><br>适用于卡片交互后向模型补充结构化动作上下文,例如按钮点击、选项选择或表单提交。 |
|
|
128
|
-
| [expiredWidget](open-api/09-开放能力-业务能力.md#expiredwidget) | 更新过期的 widget 为固定卡片。 |
|
|
129
|
-
| [loginWithDoubaoWidget](open-api/09-开放能力-业务能力.md#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
|
|
130
|
-
| [login](open-api/09-开放能力-业务能力.md#login) | 发起登录并获取登录凭证。 |
|
|
131
|
-
| [postLoginResult](open-api/09-开放能力-业务能力.md#postloginresult) | 回传 MCP 授权登录凭证。 |
|
|
132
|
-
| [createSignOrder](open-api/09-开放能力-业务能力.md#createsignorder) | 创建签约订单。 |
|
|
133
|
-
| [getOrderPaymentWithSign](open-api/09-开放能力-业务能力.md#getorderpaymentwithsign) | 使用签名信息拉起收银台完成订单支付。 |
|
|
134
|
-
| [getOrderPayment](open-api/09-开放能力-业务能力.md#getorderpayment) | 拉起收银台完成订单支付。 |
|
|
135
|
-
| [requestCombineOrder](open-api/09-开放能力-业务能力.md#requestcombineorder) | 请求创建合单订单。 |
|
|
136
|
-
| [requestOrder](open-api/09-开放能力-业务能力.md#requestorder) | 发起订单支付流程。 |
|
|
137
|
-
| [sign](open-api/09-开放能力-业务能力.md#sign) | 拉起签约流程。 |
|
|
138
|
-
| [getPrivacySetting](open-api/09-开放能力-业务能力.md#getprivacysetting) | 获取隐私设置状态。 |
|
|
139
|
-
| [sendQueryMessage](open-api/09-开放能力-业务能力.md#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void,不是 Promise。 |
|
|
140
|
-
| [setAdditionalContext](open-api/09-开放能力-业务能力.md#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
|
|
141
|
-
| [createTask](open-api/09-开放能力-业务能力.md#createtask) | 创建任务。<br><br>创建任务时需要传入开发者侧唯一任务标识、任务模板、任务详情和任务类型。开发者侧唯一任务标识 可用于幂等创建和后续业务关联。远端任务创建成功后,返回的 taskId 可用于查询或更新任务。 |
|
|
142
|
-
| [updateTask](open-api/09-开放能力-业务能力.md#updatetask) | 更新任务状态或任务详情。<br><br>更新任务时至少传入 taskStatus 或 taskDetail 中的一个。更新远端任务成功后,旧 token 会失效, 如返回 nextToken,后续需要使用新的 token 继续更新远端任务。 |
|
|
143
|
-
| [getTask](open-api/09-开放能力-业务能力.md#gettask) | 查询任务。<br><br>根据任务 ID 查询任务的模板、详情、状态和类型。若返回 token,可在后续远端任务更新中继续使用。 |
|
|
144
|
-
| [updateModelContext](open-api/09-开放能力-业务能力.md#updatemodelcontext) | 向 Agent 捐赠上下文。 |
|
|
145
|
-
| [updateWidget](open-api/09-开放能力-业务能力.md#updatewidget) | 更新指定卡片。 |
|
|
146
|
-
| [openApp](open-api/09-开放能力-业务能力.md#openapp) | 通过 deep link 等方式打开外部应用。 |
|
|
147
|
-
|
|
148
|
-
## 数据分析
|
|
149
|
-
|
|
150
|
-
监控上报、事件和数据分析上报。
|
|
151
|
-
|
|
152
|
-
| API | 说明 |
|
|
153
|
-
| --- | --- |
|
|
154
|
-
| [reportEvent](open-api/10-数据分析.md#reportevent) | 上报数据分析事件。 |
|
|
155
|
-
|
|
156
|
-
## 设备 / 蓝牙
|
|
157
|
-
|
|
158
|
-
蓝牙和 BLE 能力;通常先打开适配器,再扫描、连接和读写。
|
|
159
|
-
|
|
160
|
-
| API | 说明 |
|
|
161
|
-
| --- | --- |
|
|
162
|
-
| [openBluetoothAdapter](open-api/11-设备-蓝牙.md#openbluetoothadapter) | 打开蓝牙适配器。<br><br>蓝牙流程入口。 |
|
|
163
|
-
| [startBluetoothDevicesDiscovery](open-api/11-设备-蓝牙.md#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。<br><br>通常先调用 openBluetoothAdapter。 |
|
|
164
|
-
| [stopBluetoothDevicesDiscovery](open-api/11-设备-蓝牙.md#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
|
|
165
|
-
| [getBluetoothAdapterState](open-api/11-设备-蓝牙.md#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
|
|
166
|
-
| [getBluetoothDevices](open-api/11-设备-蓝牙.md#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。<br><br>通常先调用 startBluetoothDevicesDiscovery。 |
|
|
167
|
-
| [getConnectedBluetoothDevices](open-api/11-设备-蓝牙.md#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
|
|
168
|
-
| [makeBluetoothPair](open-api/11-设备-蓝牙.md#makebluetoothpair) | 发起蓝牙配对。 |
|
|
169
|
-
| [isBluetoothDevicePaired](open-api/11-设备-蓝牙.md#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
|
|
170
|
-
| [closeBluetoothAdapter](open-api/11-设备-蓝牙.md#closebluetoothadapter) | 关闭蓝牙适配器。<br><br>会关闭蓝牙模块。 |
|
|
171
|
-
| [createBLEConnection](open-api/11-设备-蓝牙.md#createbleconnection) | 创建 BLE 连接。<br><br>需要传入 deviceId。 |
|
|
172
|
-
| [closeBLEConnection](open-api/11-设备-蓝牙.md#closebleconnection) | 关闭 BLE 连接。 |
|
|
173
|
-
| [getBLEDeviceServices](open-api/11-设备-蓝牙.md#getbledeviceservices) | 获取 BLE 服务列表。<br><br>通常先调用 createBLEConnection。 |
|
|
174
|
-
| [getBLEDeviceCharacteristics](open-api/11-设备-蓝牙.md#getbledevicecharacteristics) | 获取 BLE 特征值列表。<br><br>通常先获取 BLE 服务列表。 |
|
|
175
|
-
| [getBLEDeviceRSSI](open-api/11-设备-蓝牙.md#getbledevicerssi) | 获取 BLE 设备 RSSI。 |
|
|
176
|
-
| [getBLEMTU](open-api/11-设备-蓝牙.md#getblemtu) | 获取 BLE MTU。 |
|
|
177
|
-
| [notifyBLECharacteristicValueChange](open-api/11-设备-蓝牙.md#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。<br><br>订阅指定特征值变化。 |
|
|
178
|
-
| [readBLECharacteristicValue](open-api/11-设备-蓝牙.md#readblecharacteristicvalue) | 读取 BLE 特征值。<br><br>需要传入 serviceId 和 characteristicId。 |
|
|
179
|
-
| [setBLEMTU](open-api/11-设备-蓝牙.md#setblemtu) | 设置 BLE MTU。 |
|
|
180
|
-
| [writeBLECharacteristicValue](open-api/11-设备-蓝牙.md#writeblecharacteristicvalue) | 写入 BLE 特征值。<br><br>value 需要是 ArrayBuffer。 |
|
|
181
|
-
|
|
182
|
-
## 设备 / Wi-Fi
|
|
183
|
-
|
|
184
|
-
Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
|
|
185
|
-
|
|
186
|
-
| API | 说明 |
|
|
187
|
-
| --- | --- |
|
|
188
|
-
| [startWifi](open-api/12-设备-wi-fi.md#startwifi) | 初始化 Wi-Fi 模块。<br><br>Wi-Fi 流程入口。 |
|
|
189
|
-
| [stopWifi](open-api/12-设备-wi-fi.md#stopwifi) | 关闭 Wi-Fi 模块。 |
|
|
190
|
-
| [setWifiList](open-api/12-设备-wi-fi.md#setwifilist) | 设置 Wi-Fi 预设列表(iOS 特有)。<br><br>该接口为 iOS 特有,用于预设 Wi-Fi 列表。 |
|
|
191
|
-
| [connectWifi](open-api/12-设备-wi-fi.md#connectwifi) | 连接指定 Wi-Fi。<br><br>通常先调用 startWifi。 |
|
|
192
|
-
| [getConnectedWifi](open-api/12-设备-wi-fi.md#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
|
|
193
|
-
| [getWifiList](open-api/12-设备-wi-fi.md#getwifilist) | 获取 Wi-Fi 列表。<br><br>通常先调用 startWifi。 |
|
|
194
|
-
| [onWifiConnected](open-api/12-设备-wi-fi.md#onwificonnected) | 监听连接上 Wi-Fi 的事件。<br><br>返回取消监听函数。 |
|
|
195
|
-
|
|
196
|
-
## 设备 / 加速度计
|
|
197
|
-
|
|
198
|
-
加速度计监听能力。
|
|
199
|
-
|
|
200
|
-
| API | 说明 |
|
|
201
|
-
| --- | --- |
|
|
202
|
-
| [startAccelerometer](open-api/13-设备-加速度计.md#startaccelerometer) | 开始监听加速度。<br><br>需配对调用 stopAccelerometer。 |
|
|
203
|
-
| [stopAccelerometer](open-api/13-设备-加速度计.md#stopaccelerometer) | 停止监听加速度。 |
|
|
204
|
-
| [onAccelerometerChange](open-api/13-设备-加速度计.md#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
|
|
205
|
-
|
|
206
|
-
## 设备 / iBeacon
|
|
207
|
-
|
|
208
|
-
iBeacon 搜索和结果读取能力。
|
|
209
|
-
|
|
210
|
-
| API | 说明 |
|
|
211
|
-
| --- | --- |
|
|
212
|
-
| [startBeaconDiscovery](open-api/14-设备-ibeacon.md#startbeacondiscovery) | 开始搜索附近的 iBeacon。<br><br>需配对调用 stopBeaconDiscovery。 |
|
|
213
|
-
| [stopBeaconDiscovery](open-api/14-设备-ibeacon.md#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
|
|
214
|
-
| [getBeacons](open-api/14-设备-ibeacon.md#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
|
|
215
|
-
|
|
216
|
-
## 设备 / 罗盘
|
|
217
|
-
|
|
218
|
-
罗盘监听能力。
|
|
219
|
-
|
|
220
|
-
| API | 说明 |
|
|
221
|
-
| --- | --- |
|
|
222
|
-
| [startCompass](open-api/15-设备-罗盘.md#startcompass) | 开始监听罗盘。<br><br>需配对调用 stopCompass。 |
|
|
223
|
-
| [stopCompass](open-api/15-设备-罗盘.md#stopcompass) | 停止监听罗盘。 |
|
|
224
|
-
| [onCompassChange](open-api/15-设备-罗盘.md#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
|
|
225
|
-
|
|
226
|
-
## 设备 / 设备方向
|
|
227
|
-
|
|
228
|
-
设备方向监听能力。
|
|
229
|
-
|
|
230
|
-
| API | 说明 |
|
|
231
|
-
| --- | --- |
|
|
232
|
-
| [startDeviceMotionListening](open-api/16-设备-设备方向.md#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
|
|
233
|
-
| [stopDeviceMotionListening](open-api/16-设备-设备方向.md#stopdevicemotionlistening) | 停止监听设备方向变化。 |
|
|
234
|
-
| [onDeviceMotionChange](open-api/16-设备-设备方向.md#ondevicemotionchange) | 监听设备方向变化事件。<br><br>返回取消监听函数。 |
|
|
235
|
-
|
|
236
|
-
## 设备 / 陀螺仪
|
|
237
|
-
|
|
238
|
-
陀螺仪监听能力。
|
|
239
|
-
|
|
240
|
-
| API | 说明 |
|
|
241
|
-
| --- | --- |
|
|
242
|
-
| [startGyroscope](open-api/17-设备-陀螺仪.md#startgyroscope) | 开始监听陀螺仪。<br><br>需配对调用 stopGyroscope。 |
|
|
243
|
-
| [stopGyroscope](open-api/17-设备-陀螺仪.md#stopgyroscope) | 停止监听陀螺仪。 |
|
|
244
|
-
| [onGyroscopeChange](open-api/17-设备-陀螺仪.md#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
|
|
245
|
-
|
|
246
|
-
## UI / 输入
|
|
247
|
-
|
|
248
|
-
键盘和输入框选区能力。
|
|
249
|
-
|
|
250
|
-
| API | 说明 |
|
|
251
|
-
| --- | --- |
|
|
252
|
-
| [getSelectedTextRange](open-api/18-ui-输入.md#getselectedtextrange) | 获取当前输入框的选区范围。 |
|
|
253
|
-
|
|
254
|
-
## 设备 / 网络
|
|
255
|
-
|
|
256
|
-
网络类型和本机局域网 IP。
|
|
257
|
-
|
|
258
|
-
| API | 说明 |
|
|
259
|
-
| --- | --- |
|
|
260
|
-
| [getLocalIPAddress](open-api/19-设备-网络.md#getlocalipaddress) | 获取局域网 IP 地址。 |
|
|
261
|
-
| [getNetworkType](open-api/19-设备-网络.md#getnetworktype) | 获取当前网络类型。 |
|
|
262
|
-
| [onNetworkStatusChange](open-api/19-设备-网络.md#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
|
|
263
|
-
|
|
264
|
-
## 设备 / 短信
|
|
265
|
-
|
|
266
|
-
拉起系统短信发送面板。
|
|
267
|
-
|
|
268
|
-
| API | 说明 |
|
|
269
|
-
| --- | --- |
|
|
270
|
-
| [sendSms](open-api/20-设备-短信.md#sendsms) | 拉起系统短信发送面板。 |
|
|
271
|
-
|
|
272
|
-
## 设备 / 无障碍
|
|
273
|
-
|
|
274
|
-
检测无障碍能力开关状态。
|
|
275
|
-
|
|
276
|
-
| API | 说明 |
|
|
277
|
-
| --- | --- |
|
|
278
|
-
| [checkIsOpenAccessibility](open-api/21-设备-无障碍.md#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
|
|
279
|
-
|
|
280
|
-
## 设备 / 基础信息
|
|
281
|
-
|
|
282
|
-
设备品牌、型号、系统、内存和性能等级。
|
|
283
|
-
|
|
284
|
-
| API | 说明 |
|
|
285
|
-
| --- | --- |
|
|
286
|
-
| [getDeviceInfo](open-api/22-设备-基础信息.md#getdeviceinfo) | 获取设备基础信息。 |
|
|
287
|
-
| [getDeviceInfoSync](open-api/22-设备-基础信息.md#getdeviceinfosync) | 同步获取设备基础信息。<br><br>同步 API。 |
|
|
288
|
-
|
|
289
|
-
## 设备 / 电池
|
|
290
|
-
|
|
291
|
-
电池信息读取与变化监听。
|
|
292
|
-
|
|
293
|
-
| API | 说明 |
|
|
294
|
-
| --- | --- |
|
|
295
|
-
| [getBatteryInfo](open-api/23-设备-电池.md#getbatteryinfo) | 获取电池信息。 |
|
|
296
|
-
| [onBatteryInfoChange](open-api/23-设备-电池.md#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
|
|
297
|
-
|
|
298
|
-
## 设备 / 日历
|
|
299
|
-
|
|
300
|
-
向系统日历添加事件和重复事件。
|
|
301
|
-
|
|
302
|
-
| API | 说明 |
|
|
303
|
-
| --- | --- |
|
|
304
|
-
| [addPhoneCalendar](open-api/24-设备-日历.md#addphonecalendar) | 向系统日历添加事件。 |
|
|
305
|
-
| [addPhoneRepeatCalendar](open-api/24-设备-日历.md#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
|
|
306
|
-
|
|
307
|
-
## 设备 / 剪贴板
|
|
308
|
-
|
|
309
|
-
读取和设置系统剪贴板内容。
|
|
310
|
-
|
|
311
|
-
| API | 说明 |
|
|
312
|
-
| --- | --- |
|
|
313
|
-
| [getClipboardData](open-api/25-设备-剪贴板.md#getclipboarddata) | 获取剪贴板内容。 |
|
|
314
|
-
| [setClipboardData](open-api/25-设备-剪贴板.md#setclipboarddata) | 设置系统剪贴板内容。 |
|
|
315
|
-
|
|
316
|
-
## 设备 / 联系人
|
|
317
|
-
|
|
318
|
-
选择和添加手机联系人。
|
|
319
|
-
|
|
320
|
-
| API | 说明 |
|
|
321
|
-
| --- | --- |
|
|
322
|
-
| [chooseContact](open-api/26-设备-联系人.md#choosecontact) | 选择手机联系人。 |
|
|
323
|
-
| [addPhoneContact](open-api/26-设备-联系人.md#addphonecontact) | 添加手机联系人。 |
|
|
324
|
-
|
|
325
|
-
## 设备 / 加密
|
|
326
|
-
|
|
327
|
-
安全随机数能力。
|
|
328
|
-
|
|
329
|
-
| API | 说明 |
|
|
330
|
-
| --- | --- |
|
|
331
|
-
| [getRandomValues](open-api/27-设备-加密.md#getrandomvalues) | 获取安全随机数。 |
|
|
332
|
-
|
|
333
|
-
## 设备 / 电话
|
|
334
|
-
|
|
335
|
-
拨打电话。
|
|
336
|
-
|
|
337
|
-
| API | 说明 |
|
|
338
|
-
| --- | --- |
|
|
339
|
-
| [makePhoneCall](open-api/28-设备-电话.md#makephonecall) | 拨打电话。 |
|
|
340
|
-
|
|
341
|
-
## 设备 / 扫码
|
|
342
|
-
|
|
343
|
-
调起扫码并读取扫码结果。
|
|
344
|
-
|
|
345
|
-
| API | 说明 |
|
|
346
|
-
| --- | --- |
|
|
347
|
-
| [scanCode](open-api/29-设备-扫码.md#scancode) | 调起扫码能力。 |
|
|
348
|
-
|
|
349
|
-
## 设备 / 屏幕
|
|
350
|
-
|
|
351
|
-
屏幕亮度、常亮和截屏/录屏相关能力。
|
|
352
|
-
|
|
353
|
-
| API | 说明 |
|
|
354
|
-
| --- | --- |
|
|
355
|
-
| [getScreenBrightness](open-api/30-设备-屏幕.md#getscreenbrightness) | 获取屏幕亮度。 |
|
|
356
|
-
| [setVisualEffectOnCapture](open-api/30-设备-屏幕.md#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。<br><br>控制截屏或录屏时的视觉效果。 |
|
|
357
|
-
| [setScreenBrightness](open-api/30-设备-屏幕.md#setscreenbrightness) | 设置屏幕亮度。 |
|
|
358
|
-
| [setKeepScreenOn](open-api/30-设备-屏幕.md#setkeepscreenon) | 设置屏幕常亮状态。 |
|
|
359
|
-
| [onUserCaptureScreen](open-api/30-设备-屏幕.md#onusercapturescreen) | 监听用户主动截屏事件。<br><br>返回取消监听函数。 |
|
|
360
|
-
|
|
361
|
-
## 设备 / 震动
|
|
362
|
-
|
|
363
|
-
触发短震动和长震动。
|
|
364
|
-
|
|
365
|
-
| API | 说明 |
|
|
366
|
-
| --- | --- |
|
|
367
|
-
| [vibrateShort](open-api/31-设备-震动.md#vibrateshort) | 触发短震动。 |
|
|
368
|
-
| [vibrateLong](open-api/31-设备-震动.md#vibratelong) | 触发长震动。 |
|
|
369
|
-
|
|
370
|
-
## 文件系统
|
|
371
|
-
|
|
372
|
-
文件读写、目录管理和文件信息操作。
|
|
373
|
-
|
|
374
|
-
| API | 说明 |
|
|
375
|
-
| --- | --- |
|
|
376
|
-
| [getFileSystemManager](open-api/32-文件系统.md#getfilesystemmanager) | 获取文件系统管理器。 |
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import"node:module";import{__webpack_require__ as _}from"./rslib-runtime.js";import"./
|
|
1
|
+
import"node:module";import{__webpack_require__ as _}from"./rslib-runtime.js";import"./733.js";var i=_("../../ai/dist/cli.js").runCli;export{i as runCli};
|
package/dist/manifest.json
CHANGED
|
@@ -32,15 +32,14 @@ Doubao Apps SDK 是豆包应用开发框架,基于 React Lynx 框架提供完
|
|
|
32
32
|
- pnpm(推荐):`npm install -g pnpm`
|
|
33
33
|
- bnpm 源:`npm config set registry https://bnpm.byted.org`
|
|
34
34
|
|
|
35
|
+
|
|
35
36
|
### 3. 创建项目
|
|
36
37
|
|
|
37
38
|
```bash
|
|
38
|
-
#
|
|
39
|
-
|
|
40
|
-
# 如果预期就地创建工程,使用 . 作为目录名
|
|
41
|
-
# npm create @byted-doubao-apps . -- --template empty -y
|
|
39
|
+
# 创建一个名为 my-doubao-app 的 empty 工程,应用 ID 为 <app-id>,路径为 <path>,务必传入当前绝对路径
|
|
40
|
+
npx -y --registry=https://bnpm.byted.org @byted-doubao-tools/doubao-cli-dev dev project create --name my-doubao-app --app-id <app-id> --path <path>
|
|
42
41
|
|
|
43
|
-
# 进入项目目录
|
|
42
|
+
# 进入项目目录
|
|
44
43
|
cd my-doubao-app
|
|
45
44
|
|
|
46
45
|
# 安装依赖
|
|
@@ -6,35 +6,3 @@
|
|
|
6
6
|
|
|
7
7
|
| 分组 | 说明 | API 数量 | 详细文档 |
|
|
8
8
|
| --- | --- | ---: | --- |
|
|
9
|
-
| 基础 / 账号 / 系统 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 | 9 | [查看](./01-基础-账号-系统.md) |
|
|
10
|
-
| 定位 | 获取设备当前的地理位置信息。 | 9 | [查看](./02-定位.md) |
|
|
11
|
-
| 存储 | 本地缓存;带 Sync 后缀的是同步 API。 | 10 | [查看](./03-存储.md) |
|
|
12
|
-
| 路由 | 应用内页面跳转、返回、退出和关闭。 | 6 | [查看](./04-路由.md) |
|
|
13
|
-
| 界面 / 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./05-界面-交互.md) |
|
|
14
|
-
| 界面 / 输入 | 键盘和输入框选区能力。 | 2 | [查看](./06-界面-输入.md) |
|
|
15
|
-
| 网络 | 网络请求与 WebSocket。 | 2 | [查看](./07-网络.md) |
|
|
16
|
-
| 媒体 | 图片选择、预览、保存、压缩和信息读取。 | 5 | [查看](./08-媒体.md) |
|
|
17
|
-
| 开放能力 / 业务能力 | 开放业务能力、支付、隐私设置、上下文和外部应用打开。 | 20 | [查看](./09-开放能力-业务能力.md) |
|
|
18
|
-
| 数据分析 | 监控上报、事件和数据分析上报。 | 1 | [查看](./10-数据分析.md) |
|
|
19
|
-
| 设备 / 蓝牙 | 蓝牙和 BLE 能力;通常先打开适配器,再扫描、连接和读写。 | 19 | [查看](./11-设备-蓝牙.md) |
|
|
20
|
-
| 设备 / Wi-Fi | Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。 | 7 | [查看](./12-设备-wi-fi.md) |
|
|
21
|
-
| 设备 / 加速度计 | 加速度计监听能力。 | 3 | [查看](./13-设备-加速度计.md) |
|
|
22
|
-
| 设备 / iBeacon | iBeacon 搜索和结果读取能力。 | 3 | [查看](./14-设备-ibeacon.md) |
|
|
23
|
-
| 设备 / 罗盘 | 罗盘监听能力。 | 3 | [查看](./15-设备-罗盘.md) |
|
|
24
|
-
| 设备 / 设备方向 | 设备方向监听能力。 | 3 | [查看](./16-设备-设备方向.md) |
|
|
25
|
-
| 设备 / 陀螺仪 | 陀螺仪监听能力。 | 3 | [查看](./17-设备-陀螺仪.md) |
|
|
26
|
-
| UI / 输入 | 键盘和输入框选区能力。 | 1 | [查看](./18-ui-输入.md) |
|
|
27
|
-
| 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./19-设备-网络.md) |
|
|
28
|
-
| 设备 / 短信 | 拉起系统短信发送面板。 | 1 | [查看](./20-设备-短信.md) |
|
|
29
|
-
| 设备 / 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./21-设备-无障碍.md) |
|
|
30
|
-
| 设备 / 基础信息 | 设备品牌、型号、系统、内存和性能等级。 | 2 | [查看](./22-设备-基础信息.md) |
|
|
31
|
-
| 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./23-设备-电池.md) |
|
|
32
|
-
| 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./24-设备-日历.md) |
|
|
33
|
-
| 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./25-设备-剪贴板.md) |
|
|
34
|
-
| 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./26-设备-联系人.md) |
|
|
35
|
-
| 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./27-设备-加密.md) |
|
|
36
|
-
| 设备 / 电话 | 拨打电话。 | 1 | [查看](./28-设备-电话.md) |
|
|
37
|
-
| 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./29-设备-扫码.md) |
|
|
38
|
-
| 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./30-设备-屏幕.md) |
|
|
39
|
-
| 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./31-设备-震动.md) |
|
|
40
|
-
| 文件系统 | 文件读写、目录管理和文件信息操作。 | 1 | [查看](./32-文件系统.md) |
|