Getting Started

Install

bun add @capgo/capacitor-firebase-storage
bunx cap sync

Import

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

API

deleteFile

Delete a file.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.deleteFile({} as DeleteFileOptions);

getDownloadUrl

ファイルのダウンロードURLを取得します。

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.getDownloadUrl({} as GetDownloadUrlOptions);

getMetadata

ファイルのメタデータを取得します。

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.getMetadata({} as GetMetadataOptions);

listFiles

ディレクトリ内のファイルの一覧を表示します。

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.listFiles({} as ListFilesOptions);

updateMetadata

ファイルのメタデータを更新します。

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.updateMetadata({} as UpdateMetadataOptions);

uploadFile

ファイルをアップロードします。

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.uploadFile({} as UploadFileOptions, {} as UploadFileCallback);

useEmulator

アプリをCloud Storage エミュレータと通信するように設定します。

Android の場合、明示的なテキストトラフィックを許可する必要があります。 Capacitor の構成で:

{
  server: {
    cleartext: true
  }
}

生データトラフィックは、実稼働環境で使用することを意図していません。

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.useEmulator({} as UseEmulatorOptions);

型リファレンス

DeleteFileOptions

export interface DeleteFileOptions {
  /**
   * The full path to the file to delete, including the file name.
   *
   * @since 5.3.0
   * @example 'mountains.png'
   * @example 'images/mountains.png'
   */
  path: string;
}

GetDownloadUrlOptions

export interface GetDownloadUrlOptions {
  /**
   * The full path to the file to get the download url for, including the file name.
   *
   * @since 5.3.0
   * @example 'mountains.png'
   * @example 'images/mountains.png'
   */
  path: string;
}

GetDownloadUrlResult

export interface GetDownloadUrlResult {
  /**
   * The download url for the file.
   *
   * @since 5.3.0
   */
  downloadUrl: string;
}

GetMetadataOptions

export interface GetMetadataOptions {
  /**
   * The full path to the file to get the metadata for, including the file name.
   *
   * @since 5.3.0
   * @example 'mountains.png'
   * @example 'images/mountains.png'
   */
  path: string;
}

GetMetadataResult

export interface GetMetadataResult {
  /**
   * The bucket this file is contained in.
   *
   * @since 5.3.0
   */
  bucket: string;
  /**
   * The timestamp at which the file was created in milliseconds since the epoch.
   *
   * @since 5.3.0
   * @example 1697304435933
   */
  createdAt?: number;
  /**
   * The object's generation.
   *
   * @since 5.3.0
   * @see https://cloud.google.com/storage/docs/metadata#generation-number
   */
  generation: string;
  /**
   * The md5 hash of the file.
   *
   * @since 5.3.0
   */
  md5Hash?: string;
  /**
   * The object's metadata generation.
   *
   * @since 5.3.0
   * @see https://cloud.google.com/storage/docs/metadata#generation-number
   */
  metadataGeneration: string;
  /**
   * The short name of this file, which is the last component of the full path.
   *
   * @since 5.3.0
   * @example 'mountains.png'
   */
  name?: string;
  /**
   * The full path to the file, including the file name.
   *
   * @since 5.3.0
   * @example 'images/mountains.png'
   */
  path?: string;
  /**
   * The size of the file in bytes.
   *
   * @since 5.3.0
   */
  size: number;
  /**
   * The timestamp at which the file was last updated in milliseconds since the epoch.
   *
   * @since 5.3.0
   * @example 1697304435933
   */
  updatedAt: number;
  /**
   * Served as the `Cache-Control` header on object download.
   *
   * @since 6.1.0
   */
  cacheControl?: string;
  /**
   * Served as the `Content-Disposition` header on object download.
   *
   * @since 6.1.0
   */
  contentDisposition?: string;
  /**
   * Served as the `Content-Encoding` header on object download.
   *
   * @since 6.1.0
   */
  contentEncoding?: string;
  /**
   * Served as the `Content-Language` header on object download.
   *
   * @since 6.1.0
   */
  contentLanguage?: string;
  /**
   * Served as the `Content-Type` header on object download.
   *
   * @since 6.1.0
   */
  contentType?: string;
  /**
   * Additional user-defined custom metadata.
   *
   * @since 6.1.0
   */
  customMetadata?: { [key: string]: string };
}

ListFilesOptions

export interface ListFilesOptions {
  /**
   * The full path to the directory to list files for.
   *
   * @since 5.3.0
   */
  path: string;
  /**
   * The maximum number of results to return.
   *
   * @since 5.3.0
   * @default 1000
   */
  maxResults?: number;
  /**
   * The page token, returned by a previous call to this method.
   * If provided, listing is resumed from the previous position.
   *
   * @since 5.3.0
   */
  pageToken?: string;
}

ListFilesResult

export interface ListFilesResult {
  /**
   * The list of files in the directory.
   *
   * @since 5.3.0
   */
  items: StorageReference[];
  /**
   * If set, there might be more results for this list.
   * Use this token to resume the list.
   *
   * @since 5.3.0
   */
  nextPageToken?: string;
}

UpdateMetadataOptions

export interface UpdateMetadataOptions {
  /**
   * The full path to the file to update the metadata for, including the file name.
   *
   * @since 5.3.0
   */
  path: string;
  /**
   * The metadata to update.
   *
   * @since 5.3.0
   */
  metadata: SettableMetadata;
}

UploadFileOptions

export interface UploadFileOptions {
  /**
   * The data to upload.
   *
   * Only available for Web.
   *
   * @since 5.3.0
   */
  blob?: Blob;
  /**
   * The full path where data should be uploaded, including the file name.
   *
   * @since 5.3.0
   * @example 'mountains.png'
   * @example 'images/mountains.png'
   */
  path: string;
  /**
   * The uri to the file to upload.
   *
   * Only available for Android and iOS.
   *
   * @since 5.3.0
   * @example 'content://com.google.android.apps.photos.contentprovider/-1/1/content://media/external/images/media/1000000214/ORIGINAL/NONE/image/.png/mountains'
   * @example 'file:///var/mobile/Containers/Data/Application/E397A70D-67E4-4258-236E-W1D9E12111D4/Library/Caches/092F8464-DE60-40B3-8A23-EB83160D9F9F/mountains.png'
   */
  uri?: string;
  /**
   * The metadata to set for the file.
   *
   * @since 5.4.0
   */
  metadata?: UploadMetadata;
}

UploadFileCallback

export type UploadFileCallback = (event: UploadFileCallbackEvent | null, error: any) => void;

CallbackId

export type CallbackId = string;

UseEmulatorOptions

export interface UseEmulatorOptions {
  /**
   * The emulator host without any port or scheme.
   *
   * Note when using a Android Emulator device: 10.0.2.2 is the special IP address to connect to the 'localhost' of the host computer.
   *
   * @since 6.1.0
   * @example "127.0.0.1"
   */
  host: string;
  /**
   * The emulator port.
   *
   * @since 6.1.0
   * @default 9199
   * @example 9199
   */
  port?: number;
}

ソース・オブ・トラース

このページはプラグインから生成されています。 src/definitions.tsAPIがアップストリームで変更されたときは、再度Syncを実行してください。

Getting Startedから続けてください。

あなたが使用している場合 ストレージとファイルハンドリングを計画するために、Getting Startedを使用している場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-data-storage-sqliteに接続してください。 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-data-storage-sqliteの実装詳細については、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-data-storage-sqliteを参照してください。 @capgo/capacitor-data-storage-sqliteを使用してください。 @capgo/capacitor-data-storage-sqliteのネイティブ機能を使用してください。 Using @capgo/capacitor-data-storage-sqlite for the native capability in Using @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file @capgo/capacitor-fileの実装詳細 @capgo/capacitor-fileを使用 @capgo/capacitor-fileを使用したネイティブ機能 @capgo/capacitor-uploader @capgo/capacitor-uploaderの実装詳細