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

属性	类型	说明
photos	PhotoAsset[]	从相册中返回的照片列表

PhotoAsset

属性	类型	说明
identifier	string	平台特定的标识符
data	string	照片资源的数据，以 base64 编码的字符串（仅支持 JPEG 格式）
creationDate	string	资源创建日期的 ISO 日期字符串
fullWidth	number	原始资源的完整宽度
fullHeight	number	原始资源的完整高度
thumbnailWidth	number	缩略图预览的宽度
thumbnailHeight	number	缩略图预览的高度
location	PhotoLocation	资源的定位元数据

PhotoLocation

属性	类型	说明
latitude	number	拍摄照片时的 GPS 纬度
longitude	number	拍摄照片时的 GPS 经度
heading	number	拍摄照片时用户的朝向
altitude	number	拍摄照片时用户的海拔高度
speed	number	拍摄照片时用户的速度

PhotosFetchOptions

属性	类型	说明
quantity	number	要获取的照片数量，按最近创建日期降序排列
thumbnailWidth	number	返回的缩略图宽度
thumbnailHeight	number	返回的缩略图高度
thumbnailQuality	number	以 JPEG 格式返回的缩略图质量（0-100）
types	string	要返回的资源类型（目前仅支持 "photos"）
albumIdentifier	string	要查询的相簿标识符（使用 getAlbums() 获取标识符）

PhotosAlbumsResult

属性	类型	说明
albums	PhotosAlbum[]	从查询中返回的相簿列表

PhotosAlbum

属性	类型	说明
identifier	string	相簿的本地标识符
name	string	相簿的名称
count	number	相簿中的项目数量
type	PhotosAlbumType	相簿的类型

PhotosAlbumsFetchOptions

属性	类型	说明
loadShared	boolean	是否加载云共享相簿

PhotosSaveResult

属性	类型	说明
success	boolean	照片是否创建成功

属性	类型	说明
data	string	照片的 base64 编码 JPEG 数据（注意：不要添加 HTML data-uri 类型前缀）
albumIdentifier	string	用于保存此照片的可选相册标识符

PhotosCreateAlbumOptions

属性	类型
name	string

枚举

PhotosAlbumType

成员	值	说明
Smart	"smart"	相册是“智能”相册（例如“收藏夹”或“最近添加”）
Shared	"shared"	相册是云端共享相册
User	"user"	相册是用户创建的相册