database.RefBuilder class

Firebase Realtime Database リファレンス ビルダーのインターフェース。

[functions.database.ref()](functions.database#.ref) を介してアクセスします。

署名:

export declare class RefBuilder<Ref extends string>

コンストラクタ

コンストラクタ 修飾キー 説明
(structor)(triggerResource, options) RefBuilder クラスの新しいインスタンスを作成します。

メソッド

メソッド 修飾キー 説明
onCreate(handler) Firebase Realtime Database で新しいデータが作成されるたびに呼び出されるイベント ハンドラ。
onDelete(handler) Firebase Realtime Database からデータが削除されるたびに呼び出されるイベント ハンドラ。
onUpdate(handler) Firebase Realtime Database でデータが更新されるたびに呼び出されるイベント ハンドラ。
onWrite(handler) Firebase Realtime Database にあらゆる種類の書き込み（作成、更新、削除）が行われるたびに呼び出されるイベント ハンドラ。

database.RefBuilder.（コンストラクタ）

RefBuilder クラスの新しいインスタンスを作成します。

署名:

constructor(triggerResource: () => string, options: DeploymentOptions);

パラメータ

パラメータ 型 説明
triggerResource () =>文字列
オプション DeploymentOptions

database.RefBuilder.onCreate()

Firebase Realtime Database で新しいデータが作成されるたびに呼び出されるイベント ハンドラ。

署名:

onCreate(handler: (snapshot: DataSnapshot, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<DataSnapshot>;

パラメータ

パラメータ 型 説明
handler （スナップショット: DataSnapshot、コンテキスト: EventContext<ParamsOf<Ref>>）=>PromiseLike<any>|すべて Firebase Realtime Database で新しいデータが作成されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DataSnapshot>

エクスポートしてデプロイできる関数。

database.RefBuilder.onDelete()

Firebase Realtime Database からデータが削除されるたびに呼び出されるイベント ハンドラ。

署名:

onDelete(handler: (snapshot: DataSnapshot, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<DataSnapshot>;

パラメータ

パラメータ 型 説明
handler （スナップショット: DataSnapshot、コンテキスト: EventContext<ParamsOf<Ref>>）=>PromiseLike<any>|すべて Firebase Realtime Database からデータが削除されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DataSnapshot>

エクスポートしてデプロイできる関数。

database.RefBuilder.onUpdate()

Firebase Realtime Database でデータが更新されるたびに呼び出されるイベント ハンドラ。

署名:

onUpdate(handler: (change: Change<DataSnapshot>, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<Change<DataSnapshot>>;

パラメータ

パラメータ 型 説明
handler （変更: Change<DataSnapshot>、コンテキスト: EventContext<ParamsOf<Ref>>）=>PromiseLike<any>|すべて Firebase Realtime Database の書き込みが発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<変更<DataSnapshot>>

エクスポートしてデプロイできる関数。

database.RefBuilder.onWrite()

Firebase Realtime Database にあらゆる種類の書き込み（作成、更新、削除）が行われるたびに呼び出されるイベント ハンドラ。

署名:

onWrite(handler: (change: Change<DataSnapshot>, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<Change<DataSnapshot>>;

パラメータ

パラメータ 型 説明
handler （変更: Change<DataSnapshot>、コンテキスト: EventContext<ParamsOf<Ref>>）=>PromiseLike<any>|すべて Firebase Realtime Database の書き込みが発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<変更<DataSnapshot>>

エクスポートしてデプロイできる関数。