database namespace

関数

関数 説明
onValueCreated(ref, handler) Realtime Database 内でデータが作成されるとトリガーされるイベント ハンドラ。
onValueCreated(opts, handler) Realtime Database 内でデータが作成されるとトリガーされるイベント ハンドラ。
onValueDeleted(ref, handler) Realtime Database 内でデータが削除されるとトリガーされるイベント ハンドラ。
onValueDeleted(opts, handler) Realtime Database 内でデータが削除されるとトリガーされるイベント ハンドラ。
onValueUpdated(ref, handler) Realtime Database 内でデータが更新されるとトリガーされるイベント ハンドラ。
onValueUpdated(opts, handler) Realtime Database 内でデータが更新されるとトリガーされるイベント ハンドラ。
onValueWritten(ref, handler) Realtime Database 内でデータが作成、更新、削除されたときにトリガーされるイベント ハンドラ。
onValueWritten(opts, handler) Realtime Database 内でデータが作成、更新、削除されたときにトリガーされるイベント ハンドラ。

クラス

クラス 説明
DataSnapshot Firebase Realtime Database のデータ スナップショットを表すインターフェース。

インターフェース

インターフェース 説明
DatabaseEvent DataSnapshot または変更を含む CloudEvent
RawRTDBCloudEvent
RawRTDBCloudEventData
ReferenceOptions ReferenceOptions は、指定された参照とオプションのインスタンスを使用して EventHandlerOptions を拡張します。

database.onValueCreated()

Realtime Database 内でデータが作成されるとトリガーされるイベント ハンドラ。

署名:

export declare function onValueCreated extends string>(ref: Ref, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
ref Ref
handler （イベント: DatabaseEvent<DataSnapshot, ParamsOf>）=>任意 |<任意> を約束する Realtime Database が作成されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<DataSnapshot、ParamsOf>>

database.onValueCreated()

Realtime Database 内でデータが作成されるとトリガーされるイベント ハンドラ。

署名:

export declare function onValueCreated extends string>(opts: ReferenceOptions, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
最適化 ReferenceOptions 個々のイベント処理関数で設定できるオプション。
handler （イベント: DatabaseEvent<DataSnapshot, ParamsOf>）=>任意 |<任意> を約束する Realtime Database が作成されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<DataSnapshot、ParamsOf>>

database.onValueDeleted()

Realtime Database 内でデータが削除されるとトリガーされるイベント ハンドラ。

署名:

export declare function onValueDeleted extends string>(ref: Ref, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
ref Ref
handler （イベント: DatabaseEvent<DataSnapshot, ParamsOf>）=>任意 |<任意> を約束する Realtime Database の削除が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<DataSnapshot、ParamsOf>>

database.onValueDeleted()

Realtime Database 内でデータが削除されるとトリガーされるイベント ハンドラ。

署名:

export declare function onValueDeleted extends string>(opts: ReferenceOptions, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
最適化 ReferenceOptions 個々のイベント処理関数で設定できるオプション。
handler （イベント: DatabaseEvent<DataSnapshot, ParamsOf>）=>任意 |<任意> を約束する Realtime Database の削除が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<DataSnapshot、ParamsOf>>

database.onValueUpdated()

Realtime Database 内でデータが更新されるとトリガーされるイベント ハンドラ。

署名:

export declare function onValueUpdated extends string>(ref: Ref, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
ref Ref
handler （イベント: DatabaseEvent<Change<DataSnapshot>、ParamsOf>）=>任意 |<任意> を約束する Realtime Database の更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf>>

database.onValueUpdated()

Realtime Database 内でデータが更新されるとトリガーされるイベント ハンドラ。

署名:

export declare function onValueUpdated extends string>(opts: ReferenceOptions, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
最適化 ReferenceOptions 個々のイベント処理関数で設定できるオプション。
handler （イベント: DatabaseEvent<Change<DataSnapshot>、ParamsOf>）=>任意 |<任意> を約束する Realtime Database の更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf>>

database.onValueWritten()

Realtime Database 内でデータが作成、更新、削除されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onValueWritten extends string>(ref: Ref, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
ref Ref
handler （イベント: DatabaseEvent<Change<DataSnapshot>、ParamsOf>）=>任意 |<任意> を約束する Realtime Database が作成、更新、削除されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf>>

database.onValueWritten()

Realtime Database 内でデータが作成、更新、削除されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onValueWritten extends string>(opts: ReferenceOptions, handler: (event: DatabaseEvent, ParamsOf>) => any | Promise): CloudFunction, ParamsOf>>;

パラメータ

パラメータ 型 説明
最適化 ReferenceOptions 個々のイベント処理関数で設定できるオプション。
handler （イベント: DatabaseEvent<Change<DataSnapshot>、ParamsOf>）=>任意 |<任意> を約束する Realtime Database が作成、更新、削除されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf>>