Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

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

Importieren

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

Quickstart

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

const result = await FirebaseFunctions.callByName({ name: 'myFunction' });
console.log(result);

Beispiel: callByUrl

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

const result = await FirebaseFunctions.callByUrl({
  url: 'https://us-central1-my-project.cloudfunctions.net/myFunction',
});
console.log(result);

Beispiel: useEmulator

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

await FirebaseFunctions.useEmulator({ host: "127.0.0.1" });

Häufige Stolperfallen

• Nativer Sync: ausführen npx cap sync nach Plugin-Upgrades.
• Single Source of Truth: Vertrauen src/definitions.ts im GitHub Repo.

API Übersicht

callByName

Rufe eine Callable Function über ihren Namen auf.

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

const result = await FirebaseFunctions.callByName({ name: 'myFunction' });
console.log(result);

callByUrl

Eine Callable Function per URL aufrufen.

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

const result = await FirebaseFunctions.callByUrl({
  url: 'https://us-central1-my-project.cloudfunctions.net/myFunction',
});
console.log(result);

useEmulator

Instrumentiere deine App, um mit dem Cloud Functions Emulator zu kommunizieren.

Unter Android muss Cleartext-Traffic erlaubt sein. In der Capacitor-Konfiguration:

{
  server: {
    cleartext: true
  }
}

Unverschlüsselter Traffic ist nicht für den Produktivbetrieb gedacht.

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

await FirebaseFunctions.useEmulator({ host: "127.0.0.1" });

Typreferenz

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für die Implementierungsdetails in API Keys, Geräte für die Implementierungsdetails in Devices und Bundles für die Implementierungsdetails in Bundles.