시작하기

설치

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. 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.

만약 Manual Setup을 선호한다면, 다음 명령어를 실행하고 아래 플랫폼별 지침을 따르세요:

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

Import

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

빠른 시작

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

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

예시: 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);

예시: useEmulator

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

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

일반적인 오류

• 자연 동기화: 업그레이드 후 실행 npx cap sync 진실의 근원
• 실제 데이터의 근원믿음 src/definitions.ts GitHub 저장소에 의존합니다.

API 개요

callByName

이름으로 호출할 수 있는 함수를 호출합니다.

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

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

callByUrl

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

useEmulator

useEmulator 제목

On Android, Android 앱에서 Capacitor에서 텍스트 트래픽을 허용해야 합니다.

{
  server: {
    cleartext: true
  }
}

생산 환경에서 텍스트 트래픽을 사용하지 않도록 의도되었습니다.

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

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

타입 참조

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 계획 대시보드와 API 작업을 진행하고 싶다면 API 개요 API 개요에서 구현 세부 정보를 확인하세요 소개 소개에서 구현 세부 정보를 확인하세요 API 키 API 키에서 구현 세부 정보를 확인하세요 장치 장치에서 구현 세부 정보에 대해 Bundle for the implementation detail in Bundle