跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

开始使用

GitHub

安装

标题为“安装”

您可以使用我们的 AI 助手设置来安装插件。将 Capgo 技能添加到您的 AI 工具中，使用以下命令:

终端窗口
npx 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-firebase-storage` plugin in my project.

如果您prefer手动设置，安装插件并运行以下命令并遵循以下平台特定说明：

终端窗口
bun add @capgo/capacitor-firebase-storage
bunx cap sync

导入

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

API概述

API概述

deleteFile

删除文件

删除一个文件。

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


await FirebaseStorage.deleteFile({} as DeleteFileOptions);

getDownloadUrl

获取下载链接

获取一个文件的下载链接。

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__

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


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

useEmulator

Section titled “useEmulator”

为应用程序配置 Cloud Storage 模拟器。

在 Android 上，必须允许清文本流量。 在 Capacitor 配置中：

{
  server: {
    cleartext: true
  }
}

不建议在生产环境中使用清文本流量。

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


await FirebaseStorage.useEmulator({} as UseEmulatorOptions);

类型参考

Section titled “Type Reference”

DeleteFileOptions

Section titled “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

Section titled “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

获取下载 URL 结果
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

回调 ID
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.ts. 当公共 API 上游更改时，请重新同步

继续从 Getting Started

标题：继续从 Getting Started

如果您正在使用 Getting Started 来规划存储和文件处理，连接它到 @capgo/capacitor-data-storage-sqlite 查看 @capgo/capacitor-data-storage-sqlite 的实现细节 使用 @capgo/capacitor-data-storage-sqlite 查看 @capgo/capacitor-data-storage-sqlite 的原生能力 @capgo/capacitor-file 查看 @capgo/capacitor-file 的实现细节 使用 @capgo/capacitor-file 为使用@capgo/capacitor文件的本地能力，和 @capgo/capacitor上传器 为@capgo/capacitor上传器的实现细节，