Device.getAlbumItems

Functional API fetchAlbumItemsYou can use the same feature with it as well.

Feature description

Select photos and videos from the user's album and fetch them. If selection is canceled, an empty array []is returned, and typesif you don't specify it, only photos are selected.

Toss app Android/iOS 5.261.0 You can use it on version and above. Before calling, Device.getAlbumItems.isSupported()you can check whether it is supported. If you call it on an unsupported version, UNSUPPORTED_APP_VERSION an error occurs.

Type

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

Params

type AlbumItemType = "PHOTO" | "VIDEO";

type FetchAlbumItemsOptions = {
  /** The list of media types to retrieve. If not specified, only photos are retrieved. */
  types?: AlbumItemType[];
  /** The maximum number of items to retrieve. The default is 10. */
  maxCount?: number;
  /** The maximum width of the image (px). The default is 1024. */
  maxWidth?: number;
  /** Whether to return the image dataUri as Base64. The default is false. */
  base64?: boolean;
};

Response

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

Error

The error code is the error.code value.

Code	Description
NOT_ALLOWED	Album access is not allowed.
INVALID_REQUEST	The request parameters are invalid.
INVALID_DATA	The media data is invalid.
UNSUPPORTED_APP_VERSION	If the running version of the Toss app doesn't support this feature, it occurs immediately upon call. Device.getAlbumItems.isSupported()Check in advance with error.messageand, if it occurs, show the user the (update guidance message).

Example code

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

async function pickAlbumItems() {
  if (!Device.getAlbumItems.isSupported()) {
    console.warn("It can't be used with the current Toss app version.");
    return;
  }

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

    if (items.length === 0) {
      console.log("The selection was canceled.");
      return;
    }
    console.log(items);
  } catch (error) {
    console.error(error);
  }
}

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