署名:
export declare class DocumentBuilder<Path extends string>
コンストラクタ
| コンストラクタ | 修飾キー | 説明 |
|---|---|---|
| (コンストラクタ)(triggerResource, options) | DocumentBuilder クラスの新しいインスタンスを作成します。 |
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| onCreate(handler) | ドキュメントの作成のみに応答します。 | |
| onDelete(handler) | ドキュメントの削除のみに応答する。 | |
| onUpdate(handler) | ドキュメントの更新のみに応答する。 | |
| onWrite(handler) | すべてのドキュメントの書き込み（作成、更新、削除）に応答する。 |
firestore.DocumentBuilder.（コンストラクタ）
DocumentBuilder クラスの新しいインスタンスを作成します。
署名:
constructor(triggerResource: () => string, options: DeploymentOptions);
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| triggerResource | () =>文字列 | |
| オプション | DeploymentOptions |
firestore.DocumentBuilder.onCreate()
ドキュメントの作成のみに応答します。
署名:
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| handler | （スナップショット: QueryDocumentSnapshot、コンテキスト: EventContext<ParamsOf<Path>>）=>PromiseLike<any>|すべて |
戻り値:
CloudFunction<QueryDocumentSnapshot>
firestore.DocumentBuilder.onDelete()
ドキュメントの削除のみに応答する。
署名:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| handler | （スナップショット: QueryDocumentSnapshot、コンテキスト: EventContext<ParamsOf<Path>>）=>PromiseLike<any>|すべて |
戻り値:
CloudFunction<QueryDocumentSnapshot>
firestore.DocumentBuilder.onUpdate()
ドキュメントの更新のみに応答する。
署名:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| handler | （変更: Change<QueryDocumentSnapshot>、コンテキスト: EventContext<ParamsOf<Path>>）=>PromiseLike<any>|すべて |
戻り値:
CloudFunction<変更<QueryDocumentSnapshot>>
firestore.DocumentBuilder.onWrite()
すべてのドキュメントの書き込み（作成、更新、削除）に応答する。
署名:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| handler | （変更: Change<DocumentSnapshot>、コンテキスト: EventContext<ParamsOf<Path>>）=>PromiseLike<any>|すべて |
戻り値:
CloudFunction<変更<DocumentSnapshot>>