Anfängsphase

Installieren

Sie können unsere KI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

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

Importieren

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

API Übersicht

deleteFile

Ein Datei löschen.

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

await FirebaseStorage.deleteFile({} as DeleteFileOptions);

getDownloadUrl

Ermitteln Sie die Download-URL für eine Datei.

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

await FirebaseStorage.getDownloadUrl({} as GetDownloadUrlOptions);

getMetadata

Ermitteln Sie die Metadaten eines Dateisystems.

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

await FirebaseStorage.getMetadata({} as GetMetadataOptions);

listFiles

Liste der Dateien in einem Verzeichnis.

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

await FirebaseStorage.listFiles({} as ListFilesOptions);

updateMetadata

Aktualisieren Sie die Metadaten eines Dateisystems.

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

await FirebaseStorage.updateMetadata({} as UpdateMetadataOptions);

uploadFile

Hochladen einer Datei.

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

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

useEmulator

Instrumentieren Sie Ihre App, um mit dem Cloud Storage-Emulator zu kommunizieren.

Bei Android muss der klare Textverkehr zugelassen werden. Auf der Capacitor-Konfiguration:

{
  server: {
    cleartext: true
  }
}

Der klare Textverkehr ist für die Produktion nicht vorgesehen.

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

await FirebaseStorage.useEmulator({} as UseEmulatorOptions);

Typenreferenz

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;
}

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Fortschritte aus Getting Started fortsetzen

Wenn Sie Getting Started verwenden Getting Started um die Speicherung und Dateimanagement zu planen, verbinden Sie es mit @capgo/capacitor-daten-speicherung-sqlite um die Implementierungsdetails in @capgo/capacitor-daten-speicherung-sqlite zu erhalten @capgo/capacitor-daten-speicherung-sqlite verwenden um die native Fähigkeit in @capgo/capacitor-daten-speicherung-sqlite zu nutzen @capgo/capacitor-datei um die Implementierungsdetails in @capgo/capacitor-datei zu erhalten @capgo/capacitor-datei verwenden für die native Fähigkeit im @capgo/capacitor-Datei und @capgo/capacitor-Uploader für die Implementierungsdetail in @capgo/capacitor-Uploader.