https namespace

الدوال

دالة الوصف
onCall(opts, handler) توضّح طريقة يمكن للعملاء الاتصال بها باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase.
onCall(handler) توضّح طريقة يمكن للعملاء الاتصال بها باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase.
onRequest(opts, handler) يعالج طلبات HTTPS.
onRequest(handler) يعالج طلبات HTTPS.

صفوف

الفئة الوصف
خطأ Https يشير ذلك المصطلح إلى خطأ صريح يمكن تنفيذه من خلال المعالج لإرسال خطأ إلى العميل الذي استدعى الدالة.

واجهات

الواجهة الوصف
CallableFunction تُنشئ طريقة يمكن للعملاء الاتصال بها باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase.
CallableOptions الخيارات التي يمكن ضبطها على دالة HTTPS قابلة للاستدعاء.
CallableRequest يشير ذلك المصطلح إلى الطلب المستخدَم لاستدعاء دالة قابلة للاستدعاء.
خيارات HTML الخيارات التي يمكن ضبطها على دالة onRequest HTTPS.
طلب تمثّل هذه السمة طلب سريع يتضمّن تمثيلاً بالتنسيق السلكي لنص الطلب.

كتابة العناوين البديلة للبريد الإلكتروني

اكتب العنوان البديل للبريد الإلكتروني الوصف
FunctionsErrorCode مجموعة رموز حالة وظائف Firebase. وتكون الرموز متطابقة مع الرموز التي يعرضها gRPC.
دالة HttpsFunction يعالج طلبات HTTPS.

https.onCall()

توضّح طريقة يمكن للعملاء الاتصال بها باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase.

Signature:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

المَعلمات

المعلمة النوع الوصف
الاختيارات CallableOptions الخيارات التي يجب ضبطها لهذه الدالة
المعالج (الطلب: CallableRequest<T>) => رحلة العودة دالة تتطلب https.CallableRequest.

المرتجعات:

CallableFunction<T, Return>

دالة يمكنك تصديرها ونشرها.

https.onCall()

توضّح طريقة يمكن للعملاء الاتصال بها باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase.

Signature:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

المَعلمات

المعلمة النوع الوصف
المعالج (الطلب: CallableRequest<T>) => رحلة العودة دالة تتطلب https.CallableRequest.

المرتجعات:

CallableFunction<T, Return>

دالة يمكنك تصديرها ونشرها.

https.onRequest()

يعالج طلبات HTTPS.

Signature:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

المَعلمات

المعلمة النوع الوصف
الاختيارات خيارات HTML الخيارات التي يجب ضبطها لهذه الدالة
المعالج (الطلب: الطلب، الردّ: Express.Response) => فارغ | وعود <باطلة> دالة تتعامل مع https.Request وكائن استجابة، تمامًا مثل تطبيق Express.

المرتجعات:

دالة HttpsFunction

دالة يمكنك تصديرها ونشرها.

https.onRequest()

يعالج طلبات HTTPS.

Signature:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

المَعلمات

المعلمة النوع الوصف
المعالج (الطلب: الطلب، الردّ: Express.Response) => فارغ | وعود <باطلة> دالة تتعامل مع https.Request وكائن استجابة، تمامًا مثل تطبيق Express.

المرتجعات:

دالة HttpsFunction

دالة يمكنك تصديرها ونشرها.

https.FunctionsErrorCode

مجموعة رموز حالة وظائف Firebase. وتكون الرموز متطابقة مع الرموز التي يعرضها gRPC.

القيم المتاحة:

  • cancelled: تم إلغاء العملية (عادةً من قِبل المتصل).

  • unknown: خطأ غير معروف أو خطأ من نطاق خطأ مختلف.

  • invalid-argument: حدَّد العميل وسيطة غير صالحة. يُرجى العِلم أنّ ذلك يختلف عن failed-precondition. تشير القيمة invalid-argument إلى الوسيطات التي تنطوي على مشاكل بغض النظر عن حالة النظام (مثل اسم حقل غير صالح).

  • deadline-exceeded: انتهت صلاحية الموعد النهائي قبل اكتمال العملية. بالنسبة للعمليات التي تغير حالة النظام، قد يتم عرض هذا الخطأ حتى إذا اكتملت العملية بنجاح. على سبيل المثال، قد تتأخر الاستجابة الناجحة من الخادم لفترة كافية لتنتهي صلاحية الموعد النهائي.

  • not-found: لم يتم العثور على بعض المستندات المطلوبة.

  • already-exists: بعض المستندات التي حاولنا إنشائها موجودة من قبل.

  • permission-denied: لا يملك المتصل إذنًا لتنفيذ العملية المحددة.

  • resource-exhausted: تم استنفاد بعض الموارد، أو ربما في حصة كل مستخدم، أو ربما نفدت مساحة نظام الملفات بالكامل.

  • failed-precondition: تم رفض العملية لأنّ النظام ليس في حالة مطلوبة لتنفيذ العملية.

  • aborted: تم إلغاء العملية، عادةً بسبب مشكلة في المزامنة، مثل عمليات إلغاء المعاملة وما إلى ذلك.

  • out-of-range: تمت محاولة العملية خارج النطاق الصالح.

  • unimplemented: لم يتم تنفيذ العملية أو أنّها غير متاحة أو مفعَّلة.

  • internal: أخطاء داخلية. يعني ذلك أنّ بعض القيم الثابتة التي يتوقعها النظام الأساسي قد تعطّلت. إذا رأيت أحد هذه الأخطاء، فهذا يعني أن شيئًا معطّلاً للغاية.

  • unavailable: الخدمة غير متاحة حاليًا. هذه حالة عابرة على الأرجح عابرة ويمكن تصحيحها عن طريق إعادة المحاولة بالتراجع.

  • data-loss: تلف أو فقدان بيانات غير قابل للإصلاح.

  • unauthenticated: لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.

Signature:

export type FunctionsErrorCode = "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.HttpsFunction

يعالج طلبات HTTPS.

Signature:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};