firebase-admin.eventarc package

Firebase Eventarc。

関数

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

クラス

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

インターフェース

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

型エイリアス

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

getEventarc(アプリ)

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

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

署名:

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

パラメータ

パラメータ 説明
アプリ アプリ 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';