抖音开放平台Logo
开发者文档
控制台

tt.saveImageToPhotosAlbum
收藏
我的收藏

基础库 1.0.0 开始支持本方法,这是一个异步方法。

保存图片到系统相册。

前提条件

该 API 需要用户授权方可调用,详细信息可参考用户授权,可在 tt.authorize 中查看相关错误码信息。

业务背景
使用限制
注意事项

手动取消也会触发失败回调,错误信息为 saveImageToPhotosAlbum:fail cancel,可以通过判断详细错误信息区分取消和其他错误。

相关教程

语法

tt.saveImageToPhotosAlbum(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
filePathstring

图片文件路径,可以是临时文件路径(如调用 tt.downloadFile 返回的路径),也可以是永久文件路径,不支持网络路径

1.0.0
successfunction
接口调用成功的回调函数
1.0.0
failfunction
接口调用失败的回调函数
1.0.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"saveImageToPhotosAlbum:ok"
1.0.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"saveImageToPhotosAlbum:fail" + 详细错误信息
1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.saveImageToPhotosAlbum({ filePath: "somepath", success(res) { console.log(`saveImageToPhotosAlbum调用成功`); }, fail(res) { console.log(`saveImageToPhotosAlbum调用失败`); }, });