__CAPGO_KEEP_1__

インストール手順とこのプラグインの全マークダウンガイドを含むセットアップコマンドをコピーします。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-functions`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/firebase-functions/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

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

インポート

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

API の概要

`callByName`

指定された名前で呼び出せる関数を呼び出します。

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

await FirebaseFunctions.callByName({} as CallByNameOptions<RequestData>);

`callByUrl`

指定されたURLで呼び出せる関数を呼び出します。

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

await FirebaseFunctions.callByUrl({} as CallByUrlOptions<RequestData>);

`useEmulator`

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

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

{
  server: {
    cleartext: true
  }
}

生産環境で使用することを意図した明示的なテキストトラフィックではありません。

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

await FirebaseFunctions.useEmulator({} as UseEmulatorOptions);

Type Reference

`CallByNameOptions`

export interface CallByNameOptions<RequestData = unknown> extends CallOptions<RequestData> {
  /**
   * The name of the callable function.
   *
   * @example 'myFunction'
   * @since 6.1.0
   */
  name: string;
  /**
   * The region of the callable function.
   *
   * @example 'us-central1'
   * @since 6.1.0
   */
  region?: string;
}

`CallByNameResult`

export type CallByNameResult<ResponseData = unknown> = CallResult<ResponseData>;

`CallByUrlOptions`

export interface CallByUrlOptions<RequestData = unknown> extends CallOptions<RequestData> {
  /**
   * The URL of the callable function.
   *
   * @example 'https://us-central1-my-project.cloudfunctions.net/myFunction'
   * @since 6.1.0
   */
  url: string;
}

`CallByUrlResult`

export type CallByUrlResult<ResponseData = unknown> = CallResult<ResponseData>;

`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 5001
   * @example 5001
   */
  port?: number;
  /**
   * The region the callable functions are located in or a custom domain hosting the callable functions.
   *
   * @example 'us-central1'
   * @example 'https://mydomain.com'
   */
  regionOrCustomDomain?: string;
}

`GetPluginVersionResult`

export interface GetPluginVersionResult {
  /**
   * The semantic version of this plugin.
   *
   * @since 8.0.1
   */
  version: string;
}

`CallResult`

export interface CallResult<ResponseData = unknown> {
  /**
   * The result of the callable function.
   *
   * @since 6.1.0
   */
  data: ResponseData;
}

真実の源

このページはプラグインから生成されています。 src/definitions.ts上流で変更された場合に、パブリック API を再度同步してください。