# uni.saveImageToPhotosAlbum(options)

保存图片到系统相册

# 参数

名称 类型 必填 默认值 描述
options SaveImageToPhotosAlbumOptions - -
名称 类型 必备 默认值 描述
filePath string.ImageURIString - 图片文件路径,可以是临时文件路径也可以是永久文件路径,不支持网络图片路径
success (callback: SaveImageToPhotosAlbumSuccess) => void | null - 接口调用成功的回调函数
fail (callback: IMediaError) => void | null - 接口调用失败的回调函数
complete (callback: any) => void | null - 接口调用结束的回调函数(调用成功、失败都会执行)
# SaveImageToPhotosAlbumSuccess 的属性值
名称 类型 必备 默认值 描述
path string - 保存到相册的图片路径
# IMediaError 的属性值
名称 类型 必备 默认值 描述
errCode 1101001 | 1101002 | 1101003 | 1101004 | 1101005 | 1101006 | 1101007 | 1101008 | 1101009 | 1101010 - 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误
errSubject string - 统一错误主题(模块)名称
data any | null - 错误信息中包含的数据
cause Error | null - 源错误信息,可以包含多个错误,详见SourceError
errMsg string - -

# saveImageToPhotosAlbum 兼容性

Android iOS web
3.9 4.11 -

# 参见

相关 Bug

# 示例

hello uni-app x

<template>
 <!-- #ifdef APP -->
 <scroll-view style="flex:1">
 <!-- #endif -->
   <image src="/static/uni.png" style="margin: 15px 100px;height:196px;width:196px;align-self:center;"></image>
   <button style="margin: 15px;" @click="saveImage">将图片保存到手机相册</button>
 <!-- #ifdef APP -->
 </scroll-view>
 <!-- #endif -->
</template>

<script>
 export default {
   data() {
     return {
     }
   },
   methods: {
     saveImage() {
       uni.saveImageToPhotosAlbum({
         filePath: "/static/uni.png",
         success() {
           uni.showToast({
             position: "center",
             icon: "none",
             title: "图片保存成功,请到手机相册查看"
           })
         },
         fail(e) {
           uni.showModal({
             content: "保存相册失败,errCode:" + e.errCode + ",errMsg:" + e.errMsg + ",errSubject:" + e.errSubject,
             showCancel: false
           });
         }
       })
     }
   }
 }
</script>

<style>
</style>

# 通用类型

# GeneralCallbackResult

名称 类型 必备 默认值 描述
errMsg string - 错误信息