وظائف السحابة الإلكترونية لبرنامج Firebase
الدوال
| دالة | الوصف |
|---|---|
| الدالّة(app, ...) | |
| getFunctions(app, territoryOrCustomDomain) | تعرض مثيل Functions للتطبيق المحدّد. |
| الدالّة(functionsInstance, ...) | |
| connectFunctionsEmulator(functionsInstance والمضيف والمنفذ) | يمكنك تعديل هذا المثيل للاتصال بمحاكي دوال السحابة.ملاحظة: يجب استدعاء هذا المثيل قبل استخدام هذا المثيل لإجراء أي عمليات. |
| httpsCallable(functionsInstance, name, options) | عرض مرجع إلى مشغّل HTTPS القابل للاستدعاء بالاسم المحدّد. |
| httpsCallableFromURL(functionsInstance, url, options) | عرض مرجع إلى مشغّل HTTPS القابل للاستدعاء باستخدام عنوان URL المحدّد. |
واجهات
| الواجهة | الوصف |
|---|---|
| الدوال | مثال Functions |
| FunctionsError | حدث خطأ من خلال حزمة تطوير البرامج (SDK) لعميل وظائف Firebase. |
| HttpsCallableOptions | واجهة للبيانات الوصفية حول كيفية تنفيذ الطلبات |
| HttpsCallableResult | تلفّ HttpsCallableResult نتيجة واحدة من استدعاء دالة. |
كتابة العناوين البديلة للبريد الإلكتروني
| اكتب العنوان البديل للبريد الإلكتروني | الوصف |
|---|---|
| FunctionsErrorCode | مجموعة رموز حالة وظائف Firebase. الرموز هي نفسها التي يعرضها gRPC هنا: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdالقيم المحتملة: - 'cancelled': تم إلغاء العملية (عادةً من قِبل المتصل). - "غير معروف": خطأ غير معروف أو خطأ من نطاق خطأ مختلف. - 'spam-argument': حدّد العميل وسيطة غير صالحة. يُرجى العِلم أنّ هذا الشرط يختلف عن الحالة "تعذّر إكمال العملية". "وسيطة غير صالحة" تشير إلى الوسيطات التي تمثل مشاكل بغض النظر عن حالة النظام (مثل اسم حقل غير صالح). - "تم تجاوز الموعد النهائي": انتهت صلاحية الموعد النهائي قبل اكتمال العملية. بالنسبة للعمليات التي تغير حالة النظام، قد يتم عرض هذا الخطأ حتى إذا اكتملت العملية بنجاح. على سبيل المثال، قد تتأخر الاستجابة الناجحة من الخادم لفترة كافية لتنتهي صلاحية الموعد النهائي. - "لم يتم العثور على الصفحة": لم يتم العثور على بعض المستندات المطلوبة. - "موجود من قبل": بعض المستندات التي حاولنا إنشائها موجودة من قبل. - "تم رفض الإذن": لا يملك المتصل إذنًا لتنفيذ العملية المحددة. - "تم استنفاد الموارد": ربما تم استنفاد بعض الموارد، أو ربما الحصة لكل مستخدم، أو نفاد المساحة في نظام الملفات بالكامل. - 'failed-precondition': تم رفض العملية لأنّ النظام ليس في حالة مطلوبة لتنفيذ العملية. - "إلغاء": تم إلغاء العملية، وذلك عادةً بسبب مشكلة تتعلق بالتزامن مثل عمليات إلغاء المعاملة أو ما إلى ذلك - "خارج النطاق": تمت محاولة العملية خارج النطاق الصالح. - "غير مُنفذة": لم يتم تنفيذ العملية أو أنّها غير متاحة/مفعَّلة - "داخلي": أخطاء داخلية يعني ذلك أنّ بعض القيم الثابتة التي يتوقعها النظام الأساسي قد تعطّلت. إذا رأيت أحد هذه الأخطاء، فهذا يعني أن شيئًا معطّلاً للغاية. - "غير متاحة": الخدمة غير متاحة حاليًا. هذه حالة عابرة على الأرجح عابرة ويمكن تصحيحها عن طريق إعادة المحاولة بالتراجع. - "data-loss" (فقدان البيانات): تلف أو فقدان بيانات غير قابل للإصلاح. - "لم تتم المصادقة": لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية. |
| FunctionsErrorCodeCore | سلسلة رمز خطأ الدوال المضافة بعد "functions/ " بادئة المنتج. راجِع FunctionsErrorCode للحصول على مستندات كاملة عن الرموز. |
| HttpsCallable | إشارة إلى كلمة "قابلة للاستدعاء" مشغل HTTP في دوال Google Cloud. |
function(app, ...)
getFunctions(app, regionOrCustomDomain)
تعرض مثيل Functions للتطبيق المحدّد.
Signature:
export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| التطبيق | تطبيق Firebase | FirebaseApp المطلوب استخدامه. |
| المنطقة أو النطاق المخصص | السلسلة | أحد: أ) المنطقة التي تقع فيها الدوال القابلة للاستدعاء (على سبيل المثال: us-central1) ب) نطاق خاص يستضيف الدوال القابلة للاتّصال (مثل: https://mydomain.com) |
المرتجعات:
function(functionsInstance, ...)
ConnectFunctionsEmulator(functionsInstance والمضيف والمنفذ)
يمكنك تعديل هذا المثيل للاتصال بمحاكي Cloud Functions.
Signature:
export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| مثيل الدوال | الدوال | |
| المضيف | السلسلة | مضيف المحاكي (مثل: localhost) |
| المنفذ | رقم | منفذ المحاكي (مثل: 5001) |
المرتجعات:
فراغ
httpsCallable(functionsInstance, name, options)
عرض مرجع إلى مشغّل HTTPS القابل للاستدعاء بالاسم المحدّد.
Signature:
export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| مثيل الدوال | الدوال | |
| الاسم | السلسلة | تمثّل هذه السمة اسم العامل المشغِّل. |
| خيارات | HttpsCallableOptions |
المرتجعات:
HttpsCallable<RequestData, ResponseData>
httpsCallableFromURL(functionsInstance, url, options)
عرض مرجع إلى مشغّل HTTPS القابل للاستدعاء باستخدام عنوان URL المحدّد.
Signature:
export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| مثيل الدوال | الدوال | |
| عنوان url | السلسلة | تمثّل هذه السمة عنوان URL للعامل المشغِّل. |
| خيارات | HttpsCallableOptions |
المرتجعات:
HttpsCallable<RequestData, ResponseData>
FunctionsErrorCode
مجموعة رموز حالة وظائف Firebase. تكون الرموز هي نفسها للرموز التي يعرضها gRPC هنا: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
القيم المحتملة: - "تم الإلغاء": تم إلغاء العملية (عادةً بواسطة المتصل). - "غير معروف": خطأ غير معروف أو خطأ من نطاق خطأ مختلف. - 'spam-argument': حدّد العميل وسيطة غير صالحة. يُرجى العِلم أنّ هذا الشرط يختلف عن الحالة "تعذّر إكمال العملية". "وسيطة غير صالحة" تشير إلى الوسيطات التي تمثل مشاكل بغض النظر عن حالة النظام (مثل اسم حقل غير صالح). - "تم تجاوز الموعد النهائي": انتهت صلاحية الموعد النهائي قبل اكتمال العملية. بالنسبة للعمليات التي تغير حالة النظام، قد يتم عرض هذا الخطأ حتى إذا اكتملت العملية بنجاح. على سبيل المثال، قد تتأخر الاستجابة الناجحة من الخادم لفترة كافية لتنتهي صلاحية الموعد النهائي. - "لم يتم العثور على الصفحة": لم يتم العثور على بعض المستندات المطلوبة. - "موجود من قبل": بعض المستندات التي حاولنا إنشائها موجودة من قبل. - "تم رفض الإذن": لا يملك المتصل إذنًا لتنفيذ العملية المحددة. - "تم استنفاد الموارد": ربما تم استنفاد بعض الموارد، أو ربما الحصة لكل مستخدم، أو نفاد المساحة في نظام الملفات بالكامل. - 'failed-precondition': تم رفض العملية لأنّ النظام ليس في حالة مطلوبة لتنفيذ العملية. - "إلغاء": تم إلغاء العملية، وذلك عادةً بسبب مشكلة تتعلق بالتزامن مثل عمليات إلغاء المعاملة أو ما إلى ذلك - "خارج النطاق": تمت محاولة العملية خارج النطاق الصالح. - "غير مُنفذة": لم يتم تنفيذ العملية أو أنّها غير متاحة/مفعَّلة - "داخلي": أخطاء داخلية يعني ذلك أنّ بعض القيم الثابتة التي يتوقعها النظام الأساسي قد تعطّلت. إذا رأيت أحد هذه الأخطاء، فهذا يعني أن شيئًا معطّلاً للغاية. - "غير متاحة": الخدمة غير متاحة حاليًا. هذه حالة عابرة على الأرجح عابرة ويمكن تصحيحها عن طريق إعادة المحاولة بالتراجع. - "data-loss" (فقدان البيانات): تلف أو فقدان بيانات غير قابل للإصلاح. - "لم تتم المصادقة": لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.
Signature:
export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
الدالة FunctionsErrorCodeCore
سلسلة رمز خطأ الدوال المضافة بعد "functions/ " بادئة المنتج. راجِع FunctionsErrorCode للحصول على مستندات كاملة عن الرموز.
Signature:
export declare type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
يمكن الاتصال بـ Https
إشارة إلى كلمة "قابلة للاستدعاء" مشغل HTTP في دوال Google Cloud.
Signature:
export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;