firebase-admin.extensions package

سرویس افزونه های Firebase.

کارکرد

تابع شرح
getExtensions (برنامه) سرویس افزونه‌ها را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. getExtensions() را می‌توان بدون هیچ آرگومان برای دسترسی به سرویس برنامه‌های Extensions برنامه پیش‌فرض یا به عنوان getExtensions(app) برای دسترسی به سرویس Extensions مرتبط با یک برنامه خاص فراخوانی کرد.

کلاس ها

کلاس شرح
برنامه های افزودنی رابط سرویس Firebase Extensions .
زمان اجرا Runtime روش هایی را برای اصلاح داده های زمان اجرا یک نمونه برنامه افزودنی ارائه می دهد.

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

نام مستعار را تایپ کنید شرح
SetableProcessingState SettableProcessingState تمام حالت های پردازشی را نشان می دهد که می توانند روی داده های زمان اجرا یک نمونه برنامه افزودنی تنظیم شوند.

getExtensions()

سرویس افزونه‌ها را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند.

getExtensions() را می‌توان بدون هیچ آرگومان برای دسترسی به سرویس برنامه‌های Extensions برنامه پیش‌فرض یا به عنوان getExtensions(app) برای دسترسی به سرویس Extensions مرتبط با یک برنامه خاص فراخوانی کرد.

امضا:

export declare function getExtensions(app?: App): Extensions;

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه برنامه اختیاری که برای بازگرداندن سرویس Extensions . اگر ارائه نشده باشد، سرویس Extensions پیش‌فرض برگردانده می‌شود.

برمی گرداند:

برنامه های افزودنی

سرویس Extensions پیش‌فرض در صورت عدم ارائه برنامه، یا سرویس برنامه‌های Extensions مرتبط با برنامه ارائه‌شده.

مثال 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

مثال 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

SetableProcessingState

SettableProcessingState تمام حالت های پردازشی را نشان می دهد که می توانند روی داده های زمان اجرا یک نمونه برنامه افزودنی تنظیم شوند.

می توانید حالت های زیر را تنظیم کنید:

  • NONE : هیچ کار مربوط به رویداد چرخه حیات انجام نشده است. این را برای پاک کردن وضعیت های قدیمی تنظیم کنید.

  • PROCESSING_COMPLETE : کار رویداد چرخه زندگی بدون خطا تکمیل شد.

  • PROCESSING_WARNING : کار رویداد چرخه حیات تا حدی با موفقیت انجام شد یا اتفاقی افتاد که باید به کاربر در مورد آن هشدار داده شود.

  • PROCESSING_FAILED : کار رویداد چرخه زندگی به طور کامل شکست خورد، اما نمونه همچنان به درستی کار خواهد کرد.

اگر نمونه برنامه افزودنی به دلیل خطا در حالت شکسته است، در عوض Runtime.setFatalError() را فراخوانی کنید. .

حالت "پردازش" به طور خودکار با شروع یک کنترل کننده رویداد چرخه حیات تنظیم می شود. شما نمی توانید آن را به صراحت تنظیم کنید. برای گزارش وضعیت جاری عملکرد یک برنامه افزودنی، از console.log یا SDK ثبت توابع Cloud استفاده کنید.

امضا:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';