firestore.DocumentBuilder class

サイン:

export declare class DocumentBuilder<Path extends string> 

コンストラクター

コンストラクタ修飾子説明
(コンストラクター)(トリガーリソース、オプション) DocumentBuilderクラスの新しいインスタンスを構築します。

メソッド

方法修飾子説明
onCreate(ハンドラー)文書作成のみに対応します。
onDelete(ハンドラー)文書の削除にのみ対応します。
onUpdate(ハンドラー)ドキュメントの更新にのみ応答します。
onWrite(ハンドラー)すべてのドキュメントの書き込み (作成、更新、または削除) に応答します。

firestore.DocumentBuilder.(コンストラクター)

DocumentBuilderクラスの新しいインスタンスを構築します。

サイン:

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

パラメーター

パラメータタイプ説明
トリガーリソース() => 文字列
オプション導入オプション

firestore.DocumentBuilder.onCreate()

文書作成のみに対応します。

サイン:

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

パラメーター

パラメータタイプ説明
ハンドラ(スナップショット: QueryDocumentSnapshot 、コンテキスト: EventContext <ParamsOf<Path>>) => PromiseLike<any> |どれでも

戻り値:

クラウドファンクション<クエリドキュメントスナップショット>

firestore.DocumentBuilder.onDelete()

文書の削除にのみ対応します。

サイン:

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

パラメーター

パラメータタイプ説明
ハンドラ(スナップショット: QueryDocumentSnapshot 、コンテキスト: EventContext <ParamsOf<Path>>) => PromiseLike<any> |どれでも

戻り値:

クラウドファンクション<クエリドキュメントスナップショット>

firestore.DocumentBuilder.onUpdate()

ドキュメントの更新にのみ応答します。

サイン:

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

パラメーター

パラメータタイプ説明
ハンドラ(変更:変更<クエリドキュメントスナップショット>、コンテキスト: EventContext <ParamsOf<Path>>) => PromiseLike<any> |どれでも

戻り値:

クラウドファンクション<変更<クエリドキュメントスナップショット>>

firestore.DocumentBuilder.onWrite()

すべてのドキュメントの書き込み (作成、更新、または削除) に応答します。

サイン:

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

パラメーター

パラメータタイプ説明
ハンドラ(変更:変更<ドキュメントスナップショット>、コンテキスト: EventContext <ParamsOf<Path>>) => PromiseLike<any> |どれでも

戻り値:

クラウドファンクション<変更<ドキュメントスナップショット>>