簽名:
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<路徑>>) => PromiseLike<任意> |任何 |
返回:
firestore.DocumentBuilder.onDelete()
僅響應文件刪除。
簽名:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
參數
範圍 | 類型 | 描述 |
---|---|---|
處理程式 | (快照: QueryDocumentSnapshot , 上下文: EventContext <ParamsOf<路徑>>) => PromiseLike<任意> |任何 |
返回:
firestore.DocumentBuilder.onUpdate()
僅響應文檔更新。
簽名:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
參數
範圍 | 類型 | 描述 |
---|---|---|
處理程式 | (改變:改變<查詢文件快照>、上下文: EventContext <ParamsOf<路徑>>) => PromiseLike<任意> |任何 |
返回:
firestore.DocumentBuilder.onWrite()
回應所有文件寫入(建立、更新或刪除)。
簽名:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
參數
範圍 | 類型 | 描述 |
---|---|---|
處理程式 | (改變:改變<文件快照>、上下文: EventContext <ParamsOf<路徑>>) => PromiseLike<任意> |任何 |
返回: