tt.saveImageToPhotosAlbum
基础库
1.0.0
开始支持本方法。
保存图片到系统相册。
该 API 需要用户授权方可调用,详细信息可参考用户授权,可在 tt.authorize 中查看相关错误码信息。
语法
tt.saveImageToPhotosAlbum(options)
参数说明
options
为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
filePath | string | 是 | 图片文件路径,可以是临时文件路径(如调用 tt.downloadFile 或 tt.compressImage 等 API 返回的路径)也可以是永久文件路径,不支持网络路径 | 1.0.0 | |
success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行),回调参数同成功或失败回调 | 1.0.0 |
回调成功
Object 类型,属性如下:
属性 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "saveImageToPhotosAlbum:ok" | 1.0.0 |
回调失败
Object 类型,属性如下:
属性 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "saveImageToPhotosAlbum:fail " + 详细错误信息 | 1.0.0 |
效果示例

扫码体验
请使用字节宿主APP扫码
代码示例
<!-- index.ttml -->
<view class="card-area">
<image mode="widthFix" src="{{filePath}}" style="width: 300px"></image>
<button type="primary" bindtap="auth">授权保存到相册</button>
<button type="primary" bindtap="saveImageToPhotosAlbum">保存</button>
</view>
// index.js
Page({
data: {
filePath: "https://s3.pstatp.com/toutiao/static/img/logo.201f80d.png",
},
auth() {
tt.authorize({
scope: "scope.album",
success: (res) => {
tt.showToast({ title: "授权成功" });
},
fail: (err) => {
console.log("authorize fail", err);
tt.showModal({
title: "授权出错",
content: err.errMsg,
showCancel: false,
});
},
});
},
saveImageToPhotosAlbum() {
tt.downloadFile({
url: this.data.filePath,
header: {
"content-type": "application/json",
},
success: (res) => {
let filePath = res.tempFilePath;
tt.saveImageToPhotosAlbum({
filePath, // 暂不支持网络图片/本地图片地址,需与tt.downloadFile一起使用
success: (res) => {
tt.showToast({ title: "成功保存到本地相册" });
},
fail: (err) => {
let errType = err.errMsg.includes("saveImageToPhotosAlbum:fail cancel")
? "取消保存"
: "保存失败";
tt.showModal({
title: errType,
content: err.errMsg,
showCancel: false,
});
},
});
},
fail: (err) => {
tt.showModal({
title: "下载出错",
content: err.errMsg,
showCancel: false,
});
},
});
},
});
Bug & Tip
- Tip:手动取消也会触发失败回调,回调参数为
saveImageToPhotosAlbum:fail cancel
,可以通过判断详细错误信息区分取消和其他错误。
点击纠错
评价此篇文档