相册
Photos API 提供了从用户照片库加载照片和相册以及保存照片的方法。
API
getPhotos(...)
getPhotos(options?: PhotosFetchOptions) => Promise<PhotosResult>
从用户照片库获取照片
| 参数 | 类型 |
|---|---|
options | |
返回:
Promise<PhotosResult>
getAlbums(...)
getAlbums(options?: PhotosAlbumsFetchOptions) => Promise<PhotosAlbumsResult>
从用户照片库获取相册
| 参数 | 类型 |
|---|---|
options | |
返回:
Promise<PhotosAlbumsResult>
savePhoto(...)
savePhoto(options?: PhotosSaveOptions) => Promise<PhotosSaveResult>
将照片保存到用户照片库
| 参数 | 类型 |
|---|---|
options | |
返回:
Promise<PhotosSaveResult>
createAlbum(...)
createAlbum(options: PhotosCreateAlbumOptions) => Promise<void>
在用户照片库中创建相册
| 参数 | 类型 |
|---|---|
options | |
接口
PhotosResult
| 属性 | 类型 | 描述 |
|---|---|---|
photos | PhotoAsset[] | 从照片库返回的照片列表 |
PhotoAsset
| 属性 | 类型 | 描述 |
|---|---|---|
identifier | string | 平台特定的标识符 |
data | string | 照片资源的数据,以 base64 编码字符串形式提供(仅支持 JPEG) |
creationDate | string | 资源创建日期的 ISO 日期字符串 |
fullWidth | number | 原始资源的完整宽度 |
fullHeight | number | 原始资源的完整高度 |
thumbnailWidth | number | 缩略图预览的宽度 |
thumbnailHeight | number | 缩略图预览的高度 |
location | | 资源的位置元数据 |
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 | | 相册类型 |
PhotosAlbumsFetchOptions
| 属性 | 类型 | 描述 |
|---|---|---|
loadShared | boolean | 是否加载云端共享相册 |
PhotosSaveResult
| 属性 | 类型 | 描述 |
|---|---|---|
success | boolean | 照片是否已创建 |
PhotosSaveOptions
| 属性 | 类型 | 描述 |
|---|---|---|
data | string | 照片的 base64 编码 JPEG 数据(注意:不要添加 HTML data-uri 类型前缀) |
albumIdentifier | string | 可选的相册标识符,用于将照片保存到该相册 |
PhotosCreateAlbumOptions
| 属性 | 类型 |
|---|---|
name | string |
枚举
PhotosAlbumType
| 成员 | 值 | 描述 |
|---|---|---|
Smart | "smart" | 相册是"智能"相册(如收藏或最近添加) |
Shared | "shared" | 相册是云端共享相册 |
User | "user" | 相册是用户创建的相册 |