Back to Uni App

Save Image To Photos Album

docs/api/save-image-to-photos-album.md

2.3.37.7 KB
Original Source
<!-- ## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum -->

::: sourceCode

uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum

GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-media

GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-media

:::

保存图片到系统相册

saveImageToPhotosAlbum 兼容性

Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>4.413.94.114.615.0

参数

名称类型必填默认值兼容性描述
optionsSaveImageToPhotosAlbumOptions-Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -

options 的属性描述

名称类型必备默认值兼容性描述
filePathstring.ImageURIString-Web: x; 微信小程序: -; Android: 3.9; iOS: 4.11; HarmonyOS: -图片文件路径,可以是临时文件路径也可以是永久文件路径,不支持网络图片路径
success(callback: SaveImageToPhotosAlbumSuccess) => void-Web: x; 微信小程序: -; Android: 3.9; iOS: 4.11; HarmonyOS: -接口调用成功的回调函数
fail(callback: SaveImageToPhotosAlbumFail) => void-Web: x; 微信小程序: -; Android: 3.9; iOS: 4.11; HarmonyOS: -接口调用失败的回调函数
complete(callback: any) => void-Web: x; 微信小程序: -; Android: 3.9; iOS: 4.11; HarmonyOS: -接口调用结束的回调函数(调用成功、失败都会执行)

SaveImageToPhotosAlbumSuccess 的属性值 @saveimagetophotosalbumsuccess-values

名称类型必备默认值兼容性描述
pathstring-Web: x; 微信小程序: -; Android: 3.9; iOS: 4.11; HarmonyOS: -保存到相册的图片路径

SaveImageToPhotosAlbumFail 的属性值 @saveimagetophotosalbumfail-values

名称类型必备默认值兼容性描述
errCodenumber-Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -错误码
errSubjectstring-Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -统一错误主题(模块)名称
dataany-Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -错误信息中包含的数据
causeError-Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -源错误信息,可以包含多个错误,详见SourceError
errMsgstring-Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -

errCode 的属性描述

合法值兼容性描述
1101001Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -用户取消
1101002Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -urls至少包含一张图片地址
1101003Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -文件不存在
1101004Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -图片加载失败
1101005Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -未获取权限
1101006Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -图片或视频保存失败
1101007Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -图片裁剪失败
1101008Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -拍照或录像失败
1101009Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -图片压缩失败
1101010Web: x; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -其他错误

示例

示例为hello uni-app x alpha分支,与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例另见

该 API 不支持 Web,请运行 hello uni-app x 到 App 平台体验

::: preview

appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/save-image-to-photos-album/save-image-to-photos-album

uvue
<template>
  <!-- #ifdef APP -->
  <scroll-view style="flex:1">
  <!-- #endif -->
    <page-head :title="title"></page-head>
    <view class="uni-padding-wrap">
      <image class="image" src="/static/test-image/logo.png"></image>
      <button class="margin-top-10" type="primary" @click="saveImage">将图片保存到手机相册</button>
    </view>
  <!-- #ifdef APP -->
  </scroll-view>
  <!-- #endif -->
</template>

<script setup lang="uts">
  const title = ref("saveImageToPhotosAlbum")

  type TestStateType = {
    success : boolean
  }

  // 使用reactive避免ref数据在自动化测试中无法访问
  const testState = reactive({
    success: false
  } as TestStateType)

  const saveImage = () => {
    uni.saveImageToPhotosAlbum({
      filePath: "/static/test-image/logo.png",
      success: (res) => {
        console.log("saveImageToPhotosAlbum success", JSON.stringify(res));
        uni.showToast({
          position: "center",
          icon: "none",
          title: "图片保存成功,请到手机相册查看"
        });
        testState.success = true;
      },
      fail: (err) => {
        uni.showModal({
          title: "保存图片到相册失败",
          content: JSON.stringify(err),
          showCancel: false
        });
        testState.success = false;
      }
    })
  }

  defineExpose({
    testState,
    saveImage
  })

</script>

<style>
  .margin-top-10 {
    margin-top: 10px;
  }

  .image {
    width: 196px;
    height: 196px;
    align-self: center;
  }
</style>

:::

参见

通用类型

GeneralCallbackResult

名称类型必备默认值兼容性描述
errMsgstring-Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -错误信息