Skip to content

sud.saveImageToPhotosAlbum ​

将本地图片保存到系统相册。

javascript
sud.saveImageToPhotosAlbum(object)

参数 ​

Object object ​

属性类型必填说明
filePathstring是图片的本地文件路径,可以是临时文件路径或永久文件路径;不支持网络 URL
successfunction否保存成功回调
failfunction否保存失败回调
completefunction否调用结束回调,成功或失败均执行

返回值 ​

异步接口,通过回调取得调用结果。

回调参数 ​

success ​

保存成功时调用,没有约定的业务返回字段。

fail ​

属性类型说明
errCodenumber错误码
errMsgstring错误信息

complete ​

在 success 或 fail 之后调用,不携带参数。

使用说明 ​

  • filePath 必须指向当前运行环境可以读取的本地图片文件。可以使用 sud.chooseImage 返回的 tempFilePaths 中的路径。
  • 网络图片应先下载到本地,再传入下载后的文件路径。
  • 文件不存在、无法读取、相册写入失败或当前环境未提供保存能力时,应处理 fail,不要仅根据接口已经调用判断保存成功。
  • 如系统要求相册或存储权限,需要用户允许相应权限后才能保存。

示例代码 ​

将已取得的本地图片路径传给 saveLocalImage,例如选择图片成功后返回的 res.tempFilePaths[0]。

javascript
function saveLocalImage(filePath) {
    sud.saveImageToPhotosAlbum({
        filePath,
        success: () => {
            console.log('图片已保存到相册');
        },
        fail: (err) => {
            console.error('保存失败', err.errCode, err.errMsg);
        },
        complete: () => {
            console.log('保存调用结束');
        },
    });
}