firestore namespace

کارکرد

تابع شرح
onDocumentCreated (سند، کنترل کننده) کنترل کننده رویداد که هنگام ایجاد سند در Firestore فعال می شود.
onDocumentCreated (انتخاب، کنترل کننده) کنترل کننده رویداد که هنگام ایجاد سند در Firestore فعال می شود.
onDocumentDeleted (سند، کنترل کننده) کنترل کننده رویداد که هنگام حذف یک سند در Firestore فعال می شود.
onDocumentDeleted (گزینه ها، کنترل کننده) کنترل کننده رویداد که هنگام حذف یک سند در Firestore فعال می شود.
onDocumentUpdated (سند، کنترل کننده) کنترل‌کننده رویداد که هنگام به‌روزرسانی یک سند در Firestore فعال می‌شود.
onDocumentUpdated (گزینه ها، کنترل کننده) کنترل‌کننده رویداد که هنگام به‌روزرسانی یک سند در Firestore فعال می‌شود.
onDocumentWritten (سند، کنترل کننده) کنترل کننده رویداد که هنگام ایجاد، به روز رسانی یا حذف یک سند در Firestore فعال می شود.
onDocumentWritten (گزینه ها، کنترل کننده) کنترل کننده رویداد که هنگام ایجاد، به روز رسانی یا حذف یک سند در Firestore فعال می شود.

کلاس ها

کلاس شرح
تغییر دادن رابط Cloud Functions برای رویدادهایی که تغییر حالت می دهند، مانند رویدادهای پایگاه داده بیدرنگ یا Cloud Firestore onWrite و onUpdate . برای اطلاعات بیشتر در مورد قالب مورد استفاده برای ساختن اشیاء Change ، به زیر مراجعه کنید.

رابط ها

رابط شرح
DocumentOptions DocumentOptions EventHandlerOptions را با سند ارائه شده و پایگاه داده و فضای نام اختیاری گسترش می دهد.
FirestoreEvent یک CloudEvent که حاوی یک DocumentSnapshot یا یک تغییر است

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
عکس مستند عکسی از اسناد Firestore
QueryDocumentSnapshot عکس Firestore QueryDocumentSnapshot

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 < QueryDocumentSnapshot | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که ایجاد Firestore رخ می دهد اجرا می شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | تعریف نشده، 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>>>;

مولفه های

پارامتر تایپ کنید شرح
انتخاب می کند DocumentOptions <سند> گزینه هایی که می توانند بر روی یک عملکرد مدیریت رویداد جداگانه تنظیم شوند.
کنترل کننده (رویداد: FirestoreEvent < QueryDocumentSnapshot | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که ایجاد Firestore رخ می دهد اجرا می شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | تعریف نشده، 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 < QueryDocumentSnapshot | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که حذف Firestore رخ می دهد اجرا می شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | تعریف نشده، 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>>>;

مولفه های

پارامتر تایپ کنید شرح
انتخاب می کند DocumentOptions <سند> گزینه هایی که می توانند بر روی یک عملکرد مدیریت رویداد جداگانه تنظیم شوند.
کنترل کننده (رویداد: FirestoreEvent < QueryDocumentSnapshot | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که حذف Firestore رخ می دهد اجرا می شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | تعریف نشده، 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 < تغییر < QueryDocumentSnapshot > | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که به روز رسانی Firestore رخ می دهد اجرا می شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < تغییر < QueryDocumentSnapshot > | تعریف نشده، 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>>>;

مولفه های

پارامتر تایپ کنید شرح
انتخاب می کند DocumentOptions <سند> گزینه هایی که می توانند بر روی یک عملکرد مدیریت رویداد جداگانه تنظیم شوند.
کنترل کننده (رویداد: FirestoreEvent < تغییر < QueryDocumentSnapshot > | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که به روز رسانی Firestore رخ می دهد اجرا می شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < تغییر < QueryDocumentSnapshot > | تعریف نشده، 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 < تغییر < DocumentSnapshot > | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که Firestore ایجاد، به‌روزرسانی یا حذف می‌کند اجرا می‌شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < تغییر < DocumentSnapshot > | تعریف نشده، 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>>>;

مولفه های

پارامتر تایپ کنید شرح
انتخاب می کند DocumentOptions <سند> گزینه هایی که می توانند بر روی یک عملکرد مدیریت رویداد جداگانه تنظیم شوند.
کنترل کننده (رویداد: FirestoreEvent < تغییر < DocumentSnapshot > | تعریف نشده، ParamsOf <سند>>) => هر | قول <هر> کنترل کننده رویداد که هر بار که Firestore ایجاد، به‌روزرسانی یا حذف می‌کند اجرا می‌شود.

برمی‌گرداند:

CloudFunction < FirestoreEvent < تغییر < DocumentSnapshot > | تعریف نشده، ParamsOf <سند>>>

firestore.DocumentSnapshot

عکسی از اسناد Firestore

امضا:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

عکس Firestore QueryDocumentSnapshot

امضا:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;