firebase-admin.eventarc package

Firebase Eventarc。

関数

関数 説明
getEventarc(アプリ) デフォルト アプリまたは特定のアプリの Eventarc サービスを取得します。引数なしで getEventarc() を呼び出してデフォルト アプリの Eventarc サービスにアクセスするか、getEventarc(app) として呼び出して、特定のアプリに関連付けられている Eventarc サービスにアクセスできます。

クラス

クラス 説明
チャネル Eventarc チャネル。
Eventarc 指定されたアプリにバインドされている Eventarc サービス。

インターフェース

インターフェース 説明
ChannelOptions チャンネル オプションのインターフェース。
CloudEvent CloudEvent はイベントデータを記述します。

型エイリアス

タイプ エイリアス 説明
CloudEventVersion CloudEvent のバージョン。

getEventarc(アプリ)

デフォルト アプリまたは特定のアプリの Eventarc サービスを取得します。

デフォルト アプリの Eventarc サービスにアクセスするには、getEventarc() を引数なしで呼び出すか、getEventarc(app) として呼び出して特定のアプリに関連付けられている Eventarc サービスにアクセスします。

署名:

export declare function getEventarc(app?: App): Eventarc;

パラメータ

パラメータ 説明
app アプリ Eventarc サービスが返される省略可能なアプリ。指定されていない場合は、デフォルトの Eventarc サービスが返されます。

戻り値:

Eventarc

アプリが指定されていない場合は、デフォルトの Eventarc サービス、または指定されたアプリに関連付けられている Eventarc サービス。

例 1

// Get the Eventarc service for the default app
const defaultEventarc = getEventarc();

例 2

// Get the Eventarc service for a given app
const otherEventarc = getEventarc(otherApp);

CloudEventVersion

CloudEvent のバージョン。

署名:

export type CloudEventVersion = '1.0';