功能
功能 | 描述 |
---|---|
onDocumentCreated(文档,处理程序) | 在 Firestore 中创建文档时触发的事件处理程序。 |
onDocumentCreated(选项,处理程序) | 在 Firestore 中创建文档时触发的事件处理程序。 |
onDocumentDeleted(文档,处理程序) | 在 Firestore 中删除文档时触发的事件处理程序。 |
onDocumentDeleted(选项,处理程序) | 在 Firestore 中删除文档时触发的事件处理程序。 |
onDocumentUpdated(文档,处理程序) | 当 Firestore 中更新文档时触发的事件处理程序。 |
onDocumentUpdated(选项,处理程序) | 当 Firestore 中更新文档时触发的事件处理程序。 |
onDocumentWritten(文档,处理程序) | 在 Firestore 中创建、更新或删除文档时触发的事件处理程序。 |
onDocumentWritten(选项,处理程序) | 在 Firestore 中创建、更新或删除文档时触发的事件处理程序。 |
课程
班级 | 描述 |
---|---|
改变 | 用于更改状态的事件的 Cloud Functions 接口,例如实时数据库或 Cloud Firestore onWrite 和onUpdate 事件。有关用于构造Change 对象的格式的更多信息,请参见下文。 |
接口
界面 | 描述 |
---|---|
文件选项 | DocumentOptions 使用提供的文档以及可选的数据库和命名空间扩展 EventHandlerOptions。 |
Firestore事件 | 包含 DocumentSnapshot 或更改的 CloudEvent |
类型别名
类型别名 | 描述 |
---|---|
文档快照 | Firestore 文档快照 |
查询文档快照 | Firestore 查询文档快照 |
firestore.onDocumentCreated()
在 Firestore 中创建文档时触发的事件处理程序。
签名:
export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
文档 | 文档 | 要触发的 Firestore 文档路径。 |
处理程序 | (事件: FirestoreEvent <查询文档快照|未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次创建 Firestore 时都会运行的事件处理程序。 |
返回:
云函数< Firestore事件<查询文档快照|未定义, ParamsOf <文件>>>
firestore.onDocumentCreated()
在 Firestore 中创建文档时触发的事件处理程序。
签名:
export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
选择 | 文件选项<文件> | 可以在单个事件处理函数上设置的选项。 |
处理程序 | (事件: FirestoreEvent <查询文档快照|未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次创建 Firestore 时都会运行的事件处理程序。 |
返回:
云函数< Firestore事件<查询文档快照|未定义, ParamsOf <文件>>>
firestore.onDocumentDeleted()
在 Firestore 中删除文档时触发的事件处理程序。
签名:
export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
文档 | 文档 | 要触发的 Firestore 文档路径。 |
处理程序 | (事件: FirestoreEvent <查询文档快照|未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次发生 Firestore 删除时都会运行的事件处理程序。 |
返回:
云函数< Firestore事件<查询文档快照|未定义, ParamsOf <文件>>>
firestore.onDocumentDeleted()
在 Firestore 中删除文档时触发的事件处理程序。
签名:
export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
选择 | 文件选项<文件> | 可以在单个事件处理函数上设置的选项。 |
处理程序 | (事件: FirestoreEvent <查询文档快照|未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次发生 Firestore 删除时都会运行的事件处理程序。 |
返回:
云函数< Firestore事件<查询文档快照|未定义, ParamsOf <文件>>>
firestore.onDocumentUpdated()
当 Firestore 中更新文档时触发的事件处理程序。
签名:
export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
文档 | 文档 | 要触发的 Firestore 文档路径。 |
处理程序 | (事件: FirestoreEvent <改变<查询文档快照> |未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次发生 Firestore 更新时运行的事件处理程序。 |
返回:
云函数< Firestore事件<改变<查询文档快照> |未定义, ParamsOf <文件>>>
firestore.onDocumentUpdated()
当 Firestore 中更新文档时触发的事件处理程序。
签名:
export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
选择 | 文件选项<文件> | 可以在单个事件处理函数上设置的选项。 |
处理程序 | (事件: FirestoreEvent <改变<查询文档快照> |未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次发生 Firestore 更新时运行的事件处理程序。 |
返回:
云函数< Firestore事件<改变<查询文档快照> |未定义, ParamsOf <文件>>>
firestore.onDocumentWritten()
在 Firestore 中创建、更新或删除文档时触发的事件处理程序。
签名:
export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
文档 | 文档 | 要触发的 Firestore 文档路径。 |
处理程序 | (事件: FirestoreEvent <改变<文档快照> |未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次发生 Firestore 创建、更新或删除时都会运行的事件处理程序。 |
返回:
云函数< Firestore事件<改变<文档快照> |未定义, ParamsOf <文件>>>
firestore.onDocumentWritten()
在 Firestore 中创建、更新或删除文档时触发的事件处理程序。
签名:
export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
参数
范围 | 类型 | 描述 |
---|---|---|
选择 | 文件选项<文件> | 可以在单个事件处理函数上设置的选项。 |
处理程序 | (事件: FirestoreEvent <改变<文档快照> |未定义, ParamsOf <文档>>) => 任何 |承诺<任何> | 每次发生 Firestore 创建、更新或删除时都会运行的事件处理程序。 |
返回:
云函数< Firestore事件<改变<文档快照> |未定义, ParamsOf <文件>>>
firestore.DocumentSnapshot
Firestore 文档快照
签名:
export type DocumentSnapshot = firestore.DocumentSnapshot;
firestore.QueryDocumentSnapshot
Firestore 查询文档快照
签名:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;