Getting Started

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사하세요.

        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

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`

앱을 클라우드 함수 에뮬레이터와 통신하도록 구성합니다.

Android에서 텍스트 전송을 허용해야 합니다. Capacitor 구성에서:

{
  server: {
    cleartext: true
  }
}

생산 환경에서 텍스트 전송을 사용하지 않습니다.

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

await FirebaseFunctions.useEmulator({} as UseEmulatorOptions);

타입 참조

`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가 변경되면 다시 싱크를 실행하세요.

Getting Started

이 페이지를 사용하는 경우 Getting Started 대시보드와 API를 계획하고 운영하기 위해 연결하세요. API Overview API 개요 구현 세부 사항에 대해 소개 __CAPGO_KEEP_0__ 키 구현 세부 사항에 대해 API 키 구현 세부 사항에 대해 for the implementation detail in API Keys, __CAPGO_KEEP_0__ 구현 세부 사항에 대해 기기 배포 __CAPGO_KEEP_0__ 구현 세부 사항에 대해 배포 페이지 편집