簽名：
export declare class DocumentBuilder<Path extends string>
建構函式
| 建構函式 | 修飾符 | 說明 |
|---|---|---|
| (buildor)(triggerResource, options) | 建構 DocumentBuilder 類別的新例項 |
方法
| 方法 | 修飾符 | 說明 |
|---|---|---|
| onCreate(處理常式) | 只回覆文件建立作業。 | |
| onDelete(處理常式) | 只回覆文件刪除事件。 | |
| onUpdate(處理常式) | 僅回覆文件更新。 | |
| onWrite(處理常式) | 回應所有文件寫入內容 (建立、更新或刪除作業)。 |
Firestore.DocumentBuilder.(建構函式)
建構 DocumentBuilder 類別的新例項
簽名：
constructor(triggerResource: () => string, options: DeploymentOptions);
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 觸發事件資源 | () =>字串 | |
| 選項 | DeploymentOptions |
Firestore.DocumentBuilder.onCreate()
只回覆文件建立作業。
簽名：
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| handler | (快照：QueryDocumentSnapshot，結構定義：EventContext<ParamsOf<Path>>) =>承諾<任何>|任何 |
傳回：
CloudFunction<QueryDocumentSnapshot>
Firestore.DocumentBuilder.onDelete()
只回覆文件刪除事件。
簽名：
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| handler | (快照：QueryDocumentSnapshot，結構定義：EventContext<ParamsOf<Path>>) =>承諾<任何>|任何 |
傳回：
CloudFunction<QueryDocumentSnapshot>
Firestore.DocumentBuilder.onUpdate()
僅回覆文件更新。
簽名：
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| handler | (變更：變更<QueryDocumentSnapshot>，情境：EventContext<ParamsOf<Path>>) =>承諾<任何>|任何 |
傳回：
CloudFunction<變更<QueryDocumentSnapshot>>
Firestore.DocumentBuilder.onWrite()
回應所有文件寫入內容 (建立、更新或刪除作業)。
簽名：
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| handler | (變更：變更<DocumentSnapshot>，情境：EventContext<ParamsOf<Path>>) =>承諾<任何>|任何 |
傳回：
CloudFunction<變更<DocumentSnapshot>>