Getting Started

インストール

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

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-functions` plugin in my project.

あなたがマニュアルセットアップを好む場合は、プラグインをインストールするには、以下のコマンドを実行し、以下のプラットフォーム固有の説明を参照してください：

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で呼び出せるcallable関数を呼びます。

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

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

useEmulator

アプリをCloud Functionsエミュレータと通信させるには、エミュレータを使用します。

On Android, the cleartext traffic must be allowed. On the Capacitor configuration:

{
  server: {
    cleartext: true
  }
}

Copy to clipboard

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

await FirebaseFunctions.useEmulator({} as UseEmulatorOptions);

Copy to clipboard

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.tsAPIがアップストリームで変更されたら、再度Syncを実行してください。

Getting Startedから続けてください

Capgoを使用している場合 Getting Started Capgoを使用してダッシュボードとAPIのオペレーションを計画する場合、Capgo Overviewと接続してください。 API Overview APIの実装詳細についてはOverviewを参照してください。 Introduction __CAPGO_KEEP_0__のキーについてはIntroductionを参照してください。 API Keys API Keysの実装詳細についてはAPI Keysを参照してください。 Devices __CAPGO_KEEP_0__の実装詳細についてはDevicesを参照してください。 Bundles __CAPGO_KEEP_0__の実装詳細についてはBundlesを参照してください。