عمليات إعادة تصدير واجهة برمجة التطبيقات الخارجية
تتم إعادة تصدير واجهات برمجة التطبيقات التالية المحددة خارجيًا من نقطة إدخال الوحدة هذه لتيسير تنفيذ ذلك.
| الرمز | الوصف |
|---|---|
| BulkWriter | النوع BulkWriter من حزمة @google-cloud/firestore. |
| AggregateField | النوع AggregateField من حزمة @google-cloud/firestore. |
| BulkWriterOptions | النوع BulkWriterOptions من حزمة @google-cloud/firestore. |
| BundleBuilder | النوع BundleBuilder من حزمة @google-cloud/firestore. |
| CollectionGroup | النوع CollectionGroup من حزمة @google-cloud/firestore. |
| CollectionReference | النوع CollectionReference من حزمة @google-cloud/firestore. |
| "تغيير المستند" | النوع DocumentChange من حزمة @google-cloud/firestore. |
| DocumentData | النوع DocumentData من حزمة @google-cloud/firestore. |
| DocumentReference | النوع DocumentReference من حزمة @google-cloud/firestore. |
| لقطة المستند | النوع DocumentSnapshot من حزمة @google-cloud/firestore. |
| FieldPath | النوع FieldPath من حزمة @google-cloud/firestore. |
| FieldValue | النوع FieldValue من حزمة @google-cloud/firestore. |
| الفلتر | النوع Filter من حزمة @google-cloud/firestore. |
| متجر إطفاء | النوع Firestore من حزمة @google-cloud/firestore. |
| FirestoreDataConverter | النوع FirestoreDataConverter من حزمة @google-cloud/firestore. |
| GeoPoint | النوع GeoPoint من حزمة @google-cloud/firestore. |
| GrpcStatus | النوع GrpcStatus من حزمة @google-cloud/firestore. |
| الشرط المُسبَق | النوع Precondition من حزمة @google-cloud/firestore. |
| طلب بحث | النوع Query من حزمة @google-cloud/firestore. |
| QueryDocumentSnapshot | النوع QueryDocumentSnapshot من حزمة @google-cloud/firestore. |
| Querypartition | النوع QueryPartition من حزمة @google-cloud/firestore. |
| لقطة طلب البحث | النوع QuerySnapshot من حزمة @google-cloud/firestore. |
| ReadOptions | النوع ReadOptions من حزمة @google-cloud/firestore. |
| SetOptions | النوع SetOptions من حزمة @google-cloud/firestore. |
| الطابع الزمني | النوع Timestamp من حزمة @google-cloud/firestore. |
| المعاملة | النوع Transaction من حزمة @google-cloud/firestore. |
| WriteBatch | النوع WriteBatch من حزمة @google-cloud/firestore. |
| WriteResult | النوع WriteResult من حزمة @google-cloud/firestore. |
| setLogFunction | setLogFunction من الحزمة @google-cloud/firestore. |
Cloud Firestore.
الدوال
| دالة | الوصف |
|---|---|
| getFirestore() | تحصل على خدمة Firestore التلقائية للتطبيق التلقائي. |
| getFirestore(app) | تحصل على خدمة Firestore التلقائية للتطبيق المحدّد. |
| getFirestore(databaseId) | (إصدار تجريبي) للحصول على خدمة Firestore المسماة للتطبيق التلقائي. |
| getFirestore(app, DatabaseId) | (إصدار تجريبي) للحصول على خدمة Firestore المُسمّاة للتطبيق المحدّد |
| تهيئةFirestore(التطبيق، الإعدادات) | يحصل على خدمة Firestore التلقائية للتطبيق المحدّد، مع تمرير معلمات إضافية إلى الدالة الإنشائية. |
| تهيئةFirestore(التطبيق، الإعدادات، قاعدة البيانات) | (إصدار تجريبي) يتيح الحصول على خدمة Firestore المسماة للتطبيق المحدّد، مع تمرير معلَمات إضافية إلى الدالة الإنشائية. |
صفوف
| الفئة | الوصف |
|---|---|
| خطأ FirebaseFirestoreError | بنية رمز خطأ Firebase Firestore يؤدي ذلك إلى إطالة FirebaseError. |
واجهات
| الواجهة | الوصف |
|---|---|
| إعدادات Firestore | الإعدادات التي سيتم تمريرها إلى الدالة الإنشائية Firestore. |
getFirestore()
تحصل على خدمة Firestore التلقائية للتطبيق التلقائي.
Signature:
export declare function getFirestore(): Firestore;
المرتجعات:
Firestore
خدمة Firestore التلقائية للتطبيق التلقائي.
مثال
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(app)
تحصل على خدمة Firestore التلقائية للتطبيق المحدّد.
Signature:
export declare function getFirestore(app: App): Firestore;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| التطبيق | التطبيق | خدمة "Firestore" المطلوب إرجاعها. |
المرتجعات:
Firestore
تشير هذه السمة إلى خدمة Firestore التلقائية المرتبطة بالتطبيق المقدّم.
مثال
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين، وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة إنتاج.
الحصول على خدمة Firestore المسماة للتطبيق التلقائي.
Signature:
export declare function getFirestore(databaseId: string): Firestore;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| معرِّف قاعدة البيانات | السلسلة | اسم قاعدة البيانات المراد إرجاعها. |
المرتجعات:
Firestore
خدمة Firestore المُسماة للتطبيق التلقائي.
مثال
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(app, DatabaseId)
يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين، وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة إنتاج.
الحصول على خدمة Firestore المسماة للتطبيق المحدّد.
Signature:
export declare function getFirestore(app: App, databaseId: string): Firestore;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| التطبيق | التطبيق | خدمة "Firestore" المطلوب إرجاعها. |
| معرِّف قاعدة البيانات | السلسلة | اسم قاعدة البيانات المراد إرجاعها. |
المرتجعات:
Firestore
خدمة Firestore المسماة والمرتبطة بالتطبيق المقدَّم.
مثال
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
تهيئةFirestore(التطبيق، الإعدادات)
يحصل على خدمة Firestore التلقائية للتطبيق المحدّد، مع تمرير معلمات إضافية إلى الدالة الإنشائية.
Signature:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| التطبيق | التطبيق | خدمة "Firestore" المطلوب إرجاعها. |
| الإعدادات | إعدادات Firestore | سيتم تمرير كائن الإعدادات إلى الدالة الإنشائية. |
المرتجعات:
Firestore
خدمة Firestore التلقائية المرتبطة بالتطبيق والإعدادات المقدَّمة
مثال
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
تهيئةFirestore(تطبيق، إعدادات، قاعدة بيانات معرفية)
يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين، وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة إنتاج.
يحصل على خدمة Firestore المسماة للتطبيق المحدّد، مع تمرير معلمات إضافية إلى الدالة الإنشائية.
Signature:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| التطبيق | التطبيق | خدمة "Firestore" المطلوب إرجاعها. |
| الإعدادات | إعدادات Firestore | سيتم تمرير كائن الإعدادات إلى الدالة الإنشائية. |
| معرِّف قاعدة البيانات | السلسلة | اسم قاعدة البيانات المراد إرجاعها. |
المرتجعات:
Firestore
خدمة "Firestore" المسماة والمرتبطة بالتطبيق والإعدادات المقدَّمة.
مثال
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');