スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用します：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-photo-library` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-photo-library
bunx cap sync

インポート

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

クイックスタート

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.checkAuthorization();
console.log(result);

例: requestAuthorization

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.requestAuthorization();
console.log(result);

例: getAlbums

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getAlbums();
console.log(result);

よくある落とし穴

• ネイティブ同期: 実行 bunx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

API の概要

checkAuthorization

ユーザーにプロンプトを表示することなく、現在の権限ステータスを返します。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.checkAuthorization();
console.log(result);

requestAuthorization

必要に応じて、フォトライブラリへのアクセスをリクエストします。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.requestAuthorization();
console.log(result);

getAlbums

利用可能なアルバムを取得します。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getAlbums();
console.log(result);

getLibrary

WebViewで表示できるURLとともに、ライブラリのアセットを取得します。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getLibrary();
console.log(result);

getPhotoUrl

アセットのフル解像度バージョンの表示可能なURLを取得します。 すでに呼び出した場合 getLibrary を使用して includeFullResolutionData、通常このメソッドは必要ありません。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getPhotoUrl({ id: 'id-123' });
console.log(result);

getThumbnailUrl

アセットのリサイズされたサムネイルを表示できるURLを取得します。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getThumbnailUrl({ id: 'id-123' });
console.log(result);

pickMedia

ネイティブのシステムピッカーを開き、写真ライブラリへのフルアクセスを許可しなくてもメディアを選択できます。 選択したファイルはアプリのキャッシュにコピーされ、ポータブルURLとして返されます。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.pickMedia();
console.log(result);

型リファレンス

PhotoLibraryAuthorizationState

export type PhotoLibraryAuthorizationState = 'authorized' | 'limited' | 'denied' | 'notDetermined';

PhotoLibraryAlbum

export interface PhotoLibraryAlbum {
  id: string;
  title: string;
  assetCount: number;
}

GetLibraryOptions

export interface GetLibraryOptions {
  /**
   * Number of assets to skip from the beginning of the query.
   */
  offset?: number;
  /**
   * Maximum number of assets to return. Omit to return everything that matches.
   */
  limit?: number;
  /**
   * Include images in the result. Defaults to `true`.
   */
  includeImages?: boolean;
  /**
   * Include videos in the result. Defaults to `false`.
   */
  includeVideos?: boolean;
  /**
   * Include information about the albums each asset belongs to. Defaults to `false`.
   */
  includeAlbumData?: boolean;
  /**
   * Include assets stored in the cloud (iCloud / Google Photos). Defaults to `true`.
   */
  includeCloudData?: boolean;
  /**
   * If `true`, use the original filenames reported by the OS when available.
   */
  useOriginalFileNames?: boolean;
  /**
   * Width of the generated thumbnails. Defaults to `512`.
   */
  thumbnailWidth?: number;
  /**
   * Height of the generated thumbnails. Defaults to `384`.
   */
  thumbnailHeight?: number;
  /**
   * JPEG quality for generated thumbnails (0-1). Defaults to `0.5`.
   */
  thumbnailQuality?: number;
  /**
   * When `true`, copies the full sized asset into the app cache and returns its URL.
   * Defaults to `false`.
   */
  includeFullResolutionData?: boolean;
}

GetLibraryResult

export interface GetLibraryResult {
  assets: PhotoLibraryAsset[];
  /**
   * Total number of assets matching the query in the library. `assets.length` can be less
   * than this value when pagination is used.
   */
  totalCount: number;
  /** Whether more assets are available when using pagination. */
  hasMore: boolean;
}

PhotoLibraryFile

export interface PhotoLibraryFile {
  /** Absolute path on the native file system. */
  path: string;
  /**
   * URL that can be used inside a web view. Usually produced by `Capacitor.convertFileSrc(path)`.
   */
  webPath: string;
  mimeType: string;
  /** Size in bytes if known, otherwise `-1`. */
  size: number;
}

PickMediaOptions

export interface PickMediaOptions {
  /**
   * Maximum number of items the user can select. Use `0` to allow unlimited selection.
   * Defaults to `1`.
   */
  selectionLimit?: number;
  /** Allow the user to select images. Defaults to `true`. */
  includeImages?: boolean;
  /** Allow the user to select videos. Defaults to `false`. */
  includeVideos?: boolean;
  /** Width of the generated thumbnails for picked items. Defaults to `256`. */
  thumbnailWidth?: number;
  /** Height of the generated thumbnails for picked items. Defaults to `256`. */
  thumbnailHeight?: number;
  /** JPEG quality for generated thumbnails (0-1). Defaults to `0.7`. */
  thumbnailQuality?: number;
}

PickMediaResult

export interface PickMediaResult {
  assets: PhotoLibraryAsset[];
}

PhotoLibraryAsset

export interface PhotoLibraryAsset {
  id: string;
  fileName: string;
  type: PhotoAssetType;
  width: number;
  height: number;
  duration?: number;
  creationDate?: string;
  modificationDate?: string;
  latitude?: number;
  longitude?: number;
  mimeType: string;
  /** Size in bytes reported by the OS for the underlying asset, if available. */
  size?: number;
  albumIds?: string[];
  thumbnail?: PhotoLibraryFile;
  file?: PhotoLibraryFile;
}

PhotoAssetType

export type PhotoAssetType = 'image' | 'video';

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-photo-library の使い方 「@capgo/capacitor-photo-library の使い方」のネイティブ機能のために API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。