跳到主要内容
版本:v2

相册

Photos API 提供了从用户照片库加载照片和相册以及保存照片的方法。

API

getPhotos(...)

getPhotos(options?: PhotosFetchOptions) => Promise<PhotosResult>

从用户照片库获取照片

参数类型
options
PhotosFetchOptions

返回:

Promise<PhotosResult>


getAlbums(...)

getAlbums(options?: PhotosAlbumsFetchOptions) => Promise<PhotosAlbumsResult>

从用户照片库获取相册

参数类型
options
PhotosAlbumsFetchOptions

返回:

Promise<PhotosAlbumsResult>


savePhoto(...)

savePhoto(options?: PhotosSaveOptions) => Promise<PhotosSaveResult>

将照片保存到用户照片库

参数类型
options
PhotosSaveOptions

返回:

Promise<PhotosSaveResult>


createAlbum(...)

createAlbum(options: PhotosCreateAlbumOptions) => Promise<void>

在用户照片库中创建相册

参数类型
options
PhotosCreateAlbumOptions

接口

PhotosResult

属性类型描述
photosPhotoAsset[]从照片库返回的照片列表

PhotoAsset

属性类型描述
identifierstring平台特定的标识符
datastring照片资源的数据,以 base64 编码字符串形式提供(仅支持 JPEG)
creationDatestring资源创建日期的 ISO 日期字符串
fullWidthnumber原始资源的完整宽度
fullHeightnumber原始资源的完整高度
thumbnailWidthnumber缩略图预览的宽度
thumbnailHeightnumber缩略图预览的高度
location
PhotoLocation
资源的位置元数据

PhotoLocation

属性类型描述
latitudenumber拍摄照片的 GPS 纬度
longitudenumber拍摄照片的 GPS 经度
headingnumber拍摄照片时用户的方向
altitudenumber拍摄照片时用户的海拔
speednumber拍摄照片时用户的速度

PhotosFetchOptions

属性类型描述
quantitynumber要获取的照片数量,按创建日期降序排列
thumbnailWidthnumber要返回的缩略图宽度
thumbnailHeightnumber要返回的缩略图高度
thumbnailQualitynumber要返回的缩略图质量,以 JPEG 格式(0-100)
typesstring要返回的资源类型(目前仅支持 "photos")
albumIdentifierstring要查询的相册标识符(使用 getAlbums() 获取标识符)

PhotosAlbumsResult

属性类型描述
albumsPhotosAlbum[]从查询返回的相册列表

PhotosAlbum

属性类型描述
identifierstring相册的本地标识符
namestring相册名称
countnumber相册中的项目数
type
PhotosAlbumType
相册类型

PhotosAlbumsFetchOptions

属性类型描述
loadSharedboolean是否加载云端共享相册

PhotosSaveResult

属性类型描述
successboolean照片是否已创建

PhotosSaveOptions

属性类型描述
datastring照片的 base64 编码 JPEG 数据(注意:不要添加 HTML data-uri 类型前缀)
albumIdentifierstring可选的相册标识符,用于将照片保存到该相册

PhotosCreateAlbumOptions

属性类型
namestring

枚举

PhotosAlbumType

成员描述
Smart"smart"相册是"智能"相册(如收藏或最近添加)
Shared"shared"相册是云端共享相册
User"user"相册是用户创建的相册