firestore namespace

Hàm

Chức năng Mô tả
onDocumentCreated(tài liệu, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo trong Firestore.
onDocumentCreated(tuỳ chọn, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo trong Firestore.
onDocumentDeleted(tài liệu, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu bị xoá trong Firestore.
onDocumentxoá(tuỳ chọn, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu bị xoá trong Firestore.
onDocumentUpdated(tài liệu, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu được cập nhật trong Firestore.
onDocumentUpdated(tuỳ chọn, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu được cập nhật trong Firestore.
onDocumentWrite(tài liệu, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo, cập nhật hoặc xoá trong Firestore.
onDocumentWrite(tuỳ chọn, trình xử lý) Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo, cập nhật hoặc xoá trong Firestore.

Lớp học

Hạng Mô tả
Thay đổi Giao diện Cloud Functions cho các sự kiện thay đổi trạng thái, chẳng hạn như Cơ sở dữ liệu theo thời gian thực hoặc các sự kiện onWrite và onUpdate trên Cloud Firestore.Để biết thêm thông tin về định dạng dùng để tạo đối tượng Change, hãy xem phần bên dưới.

Giao diện

Giao diện Mô tả
DocumentOptions (Tùy chọn tài liệu) DocumentOptions mở rộng EventHandlerOptions với tài liệu được cung cấp cũng như cơ sở dữ liệu và không gian tên tuỳ chọn.
FirestoreEvent Một CloudEvent có chứa một DocumentSnapshot hoặc một Change (Thay đổi)

Nhập bí danh

Nhập bí danh Mô tả
Ảnh chụp màn hình tài liệu Ảnh chụp tài liệu trên Firestore
Truy vấn tài liệu ảnh chụp nhanh Ảnh truy vấn tài liệu trên Firestore

Firestore.onDocumentCreated()

Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
tài liệu Tài liệu Đường dẫn tài liệu trên Firestore để kích hoạt.
trình xử lý (sự kiện: FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi có một lượt tạo Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentCreated()

Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
chọn DocumentOptions<Tài liệu> Các lựa chọn có thể được đặt cho từng chức năng xử lý sự kiện riêng lẻ.
trình xử lý (sự kiện: FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi có một lượt tạo Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentXoá()

Trình xử lý sự kiện kích hoạt khi một tài liệu bị xoá trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
tài liệu Tài liệu Đường dẫn tài liệu trên Firestore để kích hoạt.
trình xử lý (sự kiện: FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi xảy ra một lệnh xoá Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentXoá()

Trình xử lý sự kiện kích hoạt khi một tài liệu bị xoá trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
chọn DocumentOptions<Tài liệu> Các lựa chọn có thể được đặt cho từng chức năng xử lý sự kiện riêng lẻ.
trình xử lý (sự kiện: FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi xảy ra một lệnh xoá Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentUpdated()

Trình xử lý sự kiện kích hoạt khi một tài liệu được cập nhật trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
tài liệu Tài liệu Đường dẫn tài liệu trên Firestore để kích hoạt.
trình xử lý (sự kiện: FirestoreEvent<Thay đổi<QueryDocumentSnapshot> | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi có quá trình cập nhật Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<Thay đổi<QueryDocumentSnapshot> | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentUpdated()

Trình xử lý sự kiện kích hoạt khi một tài liệu được cập nhật trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
chọn DocumentOptions<Tài liệu> Các lựa chọn có thể được đặt cho từng chức năng xử lý sự kiện riêng lẻ.
trình xử lý (sự kiện: FirestoreEvent<Thay đổi<QueryDocumentSnapshot> | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi có quá trình cập nhật Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<Thay đổi<QueryDocumentSnapshot> | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentRecord()

Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo, cập nhật hoặc xoá trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
tài liệu Tài liệu Đường dẫn tài liệu trên Firestore để kích hoạt.
trình xử lý (sự kiện: FirestoreEvent<Thay đổi<DocumentSnapshot> | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi có một lượt tạo, cập nhật hoặc xoá trên Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<Thay đổi<DocumentSnapshot> | không xác định, ParamsOf<Tài liệu>>>

Firestore.onDocumentRecord()

Trình xử lý sự kiện kích hoạt khi một tài liệu được tạo, cập nhật hoặc xoá trong Firestore.

Chữ ký:

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>>>;

Thông số

Thông số Loại Mô tả
chọn DocumentOptions<Tài liệu> Các lựa chọn có thể được đặt cho từng chức năng xử lý sự kiện riêng lẻ.
trình xử lý (sự kiện: FirestoreEvent<Thay đổi<DocumentSnapshot> | không xác định, ParamsOf<Document>>) => bất kỳ | Cam kết<bất kỳ> Trình xử lý sự kiện được chạy mỗi khi có một lượt tạo, cập nhật hoặc xoá trên Firestore.

Trường hợp trả lại hàng:

CloudFunction<FirestoreEvent<Thay đổi<DocumentSnapshot> | không xác định, ParamsOf<Tài liệu>>>

Firestore.DocumentSnapshot

Ảnh chụp tài liệu trên Firestore

Chữ ký:

export type DocumentSnapshot = firestore.DocumentSnapshot;

Firestore.QueryDocumentSnapshot

Ảnh truy vấn tài liệu trên Firestore

Chữ ký:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;