Démarrage

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la commande suivante :

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

Si vous préférez la mise en place manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à votre plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

callByName

Appeler une fonction appelable par son nom.

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

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

callByUrl

Appeler une fonction appelable par son URL.

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

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

useEmulator

Instrumentez votre application pour communiquer avec l'émulateur de Cloud Functions.

Sur Android, le trafic clair doit être autorisé. Dans la configuration Capacitor :

{
  server: {
    cleartext: true
  }
}

Le trafic clair n'est pas destiné à être utilisé en production.

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

await FirebaseFunctions.useEmulator({} as UseEmulatorOptions);

Référence de type

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 de Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-générez la synchronisation lorsque l’API publique change en amont.

Continuez de la section « Commencer »

Si vous utilisez Commencer pour planifier le tableau de bord et les opérations API, connectez-l’avec API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés Appareils pour les détails d'implémentation dans Appareils, et Ensembles pour les détails d'implémentation dans Ensembles.