For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/media/saveImageToPhotosAlbum.md.

saveImageToPhotosAlbum

保存图片到系统相册。

需要先确保应用已具备写入系统相册的权限。

扫码预览

扫码预览 saveImageToPhotosAlbum

支持版本

前端库版本不低于 0.0.26。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片不支持

接入准备

权限要求

类型标识是否必须平台说明
系统权限相册写入权限按条件Android、iOS系统版本要求相册或外部存储写入授权时需要授予

授权行为

  • Android:API 不主动展示应用授权弹窗。系统版本要求外部存储写入权限且权限未授予时,保存会失败;请引导用户在系统设置中开启后重试。
  • iOS:首次写入系统相册时由系统请求相册写入权限。用户拒绝或撤销后保存失败;请引导用户在系统设置中开启后重试。

前置条件

  • 传入豆包应用插件可访问、存在且可解码的本地图片路径

调用方式

异步 API

saveImageToPhotosAlbum(params: SaveImageToPhotosAlbumParams): Promise<object>

入参

名称类型必填默认值约束说明
filePathstring是--需要保存的图片文件路径。支持临时文件路径或持久文件路径,不支持网络图片路径。

调用示例

import { saveImageToPhotosAlbum } from '@doubao-dev/framework/api';

await saveImageToPhotosAlbum({
  filePath: '/path/to/image.png'
});

成功返回

无返回字段。

返回示例

{}