Device.getAlbumItems

函数式 API fetchAlbumItems也可以通过它使用相同的功能。

功能说明

从用户相册中选择并获取照片·视频。若取消选择，则返回空数组 []并返回， types如果不指定，则只会选择照片。

Toss App Android/iOS 5.261.0 可在以上版本中使用。调用前 Device.getAlbumItems.isSupported()可通过它确认是否支持。若在不支持的版本中调用， UNSUPPORTED_APP_VERSION 会发生错误。

类型

Device.getAlbumItems(options?: FetchAlbumItemsOptions): Promise<AlbumItemResponse[]>;

Params

type AlbumItemType = "PHOTO" | "VIDEO";

type FetchAlbumItemsOptions = {
  /** 要获取的媒体类型列表。若不指定，则只获取照片。 */
  types?: AlbumItemType[];
  /** 要获取的项目最大数量。默认值为 10。 */
  maxCount?: number;
  /** 图片的最大宽度（px）。默认值为 1024。 */
  maxWidth?: number;
  /** 是否将图片 dataUri 以 Base64 返回。默认值为 false。 */
  base64?: boolean;
};

Response

type AlbumItemResponse = {
  id: string;
  dataUri: string;
  type: "PHOTO" | "VIDEO";
};

错误

错误代码是 catch 到的错误的 error.code 值。

代码	说明
NOT_ALLOWED	相册访问未被允许的情况。
INVALID_REQUEST	请求参数不正确的情况。
INVALID_DATA	媒体数据无效的情况。
UNSUPPORTED_APP_VERSION	如果当前运行的 Toss App 版本不支持此功能，调用后会立即发生。 Device.getAlbumItems.isSupported()可通过它提前确认，发生时 error.message请向用户显示（更新提示文案）。

示例代码

import { Device } from "@apps-in-toss/web-framework";

async function pickAlbumItems() {
  if (!Device.getAlbumItems.isSupported()) {
    console.warn("当前 Toss App 版本中无法使用。");
    return;
  }

  try {
    const items = await Device.getAlbumItems({
      types: ["PHOTO", "VIDEO"],
      maxCount: 5,
      base64: true,
    });

    if (items.length === 0) {
      console.log("选择已取消。");
      return;
    }
    console.log(items);
  } catch (error) {
    console.error(error);
  }
}

document.getElementById("pick-media").addEventListener("click", pickAlbumItems);