https namespace

المهام

وظيفة وصف
onCall (الخيارات، المعالج) يعلن عن طريقة قابلة للاستدعاء للعملاء للاتصال باستخدام Firebase SDK.
عند الطلب (معالج) يعلن عن طريقة قابلة للاستدعاء للعملاء للاتصال باستخدام Firebase SDK.
عند الطلب (الخيارات، المعالج) يتعامل مع طلبات HTTPS.
عند الطلب (معالج) يتعامل مع طلبات HTTPS.

الطبقات

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

واجهات

واجهه المستخدم وصف
CallableFunction ينشئ طريقة قابلة للاستدعاء للعملاء للاتصال باستخدام Firebase SDK.
CallableOptions الخيارات التي يمكن ضبطها على وظيفة HTTPS قابلة للاستدعاء.
طلب CallableRequest الطلب المستخدم لاستدعاء وظيفة قابلة للاستدعاء.
خيارات هتبس الخيارات التي يمكن ضبطها على وظيفة onRequest HTTPS.
طلب طلب صريح مع تمثيل التنسيق السلكي لنص الطلب.

اكتب الأسماء المستعارة

اكتب الاسم المستعار وصف
وظائف خطأ رمز مجموعة رموز حالة وظائف Firebase. الرموز هي نفسها التي تم الكشف عنها بواسطة gRPC .
وظيفة هتبس يتعامل مع طلبات HTTPS.

https.onCall()

يعلن عن طريقة قابلة للاستدعاء للعملاء للاتصال باستخدام Firebase SDK.

إمضاء:

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()

يعلن عن طريقة قابلة للاستدعاء للعملاء للاتصال باستخدام Firebase SDK.

إمضاء:

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.

إمضاء:

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

حدود

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

عائدات:

وظيفة هتبس

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

https.onRequest()

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

إمضاء:

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

حدود

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

عائدات:

وظيفة هتبس

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

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 : لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.

إمضاء:

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.

إمضاء:

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