installations package

Firebase Installations Web SDK. این SDK در محیط Node.js کار نمی کند.

کارکرد

تابع شرح
عملکرد (برنامه، ...)
getInstallations (برنامه) نمونه ای از نصب های مرتبط با نمونه FirebaseApp داده شده را برمی گرداند.
عملکرد (تاسیسات، ...)
deleteInstallations(Installations) نصب Firebase و تمام داده های مرتبط را حذف می کند.
getId (نصب ها) اگر نصبی برای برنامه وجود نداشته باشد، یک نصب Firebase ایجاد می‌کند و شناسه نصب را برمی‌گرداند.
getToken (نصب، forceRefresh) نشانه تأیید اعتبار Firebase Installations را برمی‌گرداند که نصب فعلی Firebase را شناسایی می‌کند.
onIdChange (نصب، پاسخ به تماس) یک تماس پاسخ جدید تنظیم می کند که با تغییر شناسه نصب، تماس گرفته می شود. یک تابع لغو اشتراک را برمی‌گرداند که هنگام فراخوانی، پاسخ تماس را حذف می‌کند.

رابط ها

رابط شرح
تاسیسات رابط عمومی Firebase Installations SDK.

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

نام مستعار را تایپ کنید شرح
IdChangeCallbackFn یک تابع بازخوانی تعریف شده توسط کاربر که با تغییر شناسه نصب فراخوانی می شود.
IdChangeUnsubscribeFn لغو اشتراک تابع برگشت به تماس که قبلاً از طریق IdChangeCallbackFn اضافه شده است .

عملکرد (برنامه، ...)

getInstallations (برنامه)

نمونه ای از نصب های مرتبط با نمونه FirebaseApp داده شده را برمی گرداند.

امضا:

export declare function getInstallations(app?: FirebaseApp): Installations;

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App نمونه FirebaseApp .

برمی گرداند:

تاسیسات

عملکرد (تاسیسات، ...)

deleteInstallations(Installations)

نصب Firebase و تمام داده های مرتبط را حذف می کند.

امضا:

export declare function deleteInstallations(installations: Installations): Promise<void>;

مولفه های

پارامتر تایپ کنید شرح
تاسیسات تاسیسات نمونه Installations

برمی گرداند:

قول<باطل>

getId (نصب ها)

اگر نصبی برای برنامه وجود نداشته باشد، یک نصب Firebase ایجاد می‌کند و شناسه نصب را برمی‌گرداند.

امضا:

export declare function getId(installations: Installations): Promise<string>;

مولفه های

پارامتر تایپ کنید شرح
تاسیسات تاسیسات نمونه Installations

برمی گرداند:

قول<رشته>

getToken (نصب، forceRefresh)

نشانه تأیید اعتبار Firebase Installations را برمی‌گرداند که نصب فعلی Firebase را مشخص می‌کند.

امضا:

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

مولفه های

پارامتر تایپ کنید شرح
تاسیسات تاسیسات نمونه Installations
forceRefresh بولی اجباری به‌روزرسانی بدون در نظر گرفتن انقضای رمز.

برمی گرداند:

قول<رشته>

onIdChange (نصب، پاسخ به تماس)

یک تماس پاسخ جدید تنظیم می کند که با تغییر شناسه نصب، تماس گرفته می شود. یک تابع لغو اشتراک را برمی‌گرداند که هنگام فراخوانی، پاسخ تماس را حذف می‌کند.

امضا:

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

مولفه های

پارامتر تایپ کنید شرح
تاسیسات تاسیسات نمونه Installations
پاسخ به تماس IdChangeCallbackFn تابع callback که هنگام تغییر FID فراخوانی می شود.

برمی گرداند:

IdChangeUnsubscribeFn

تابعی که می توان آن را برای لغو اشتراک فراخوانی کرد.

IdChangeCallbackFn

یک تابع بازخوانی تعریف شده توسط کاربر که با تغییر شناسه نصب فراخوانی می شود.

امضا:

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdChangeUnsubscribeFn

لغو اشتراک تابع برگشت به تماس که قبلاً از طریق IdChangeCallbackFn اضافه شده است .

امضا:

export declare type IdChangeUnsubscribeFn = () => void;