Firebase Installations Web SDK. SDK זה לא עובד בסביבת Node.js.
פונקציות
פוּנקצִיָה | תיאור |
---|---|
פונקציה (אפליקציה,...) | |
getInstallations(אפליקציה) | מחזיר מופע של התקנות המשויך למופע הנתון של FirebaseApp . |
פונקציה (התקנות,...) | |
מחק התקנות (התקנות) | מוחק את התקנת Firebase ואת כל הנתונים המשויכים. |
getId(installations) | יוצר התקנה של Firebase אם אין כזו עבור האפליקציה ומחזיר את מזהה ההתקנה. |
getToken(התקנות, forceRefresh) | מחזירה אסימון אישור של Firebase Installations, המזהה את התקנת Firebase הנוכחית. |
onIdChange(התקנות, התקשרות חוזרת) | מגדיר התקשרות חוזרת חדשה שתיקרא כאשר מזהה ההתקנה משתנה. מחזירה פונקציית ביטול הרשמה שתסיר את ההתקשרות חזרה בעת ההתקשרות. |
ממשקים
מִמְשָׁק | תיאור |
---|---|
התקנות | ממשק ציבורי של Firebase Installations SDK. |
הקלד כינויים
הקלד כינוי | תיאור |
---|---|
IdChangeCallbackFn | פונקציית התקשרות חוזרת המוגדרת על ידי המשתמש הנקראת כאשר מזהה התקנות משתנה. |
IdChangeUnsubscribeFn | בטל את הרישום של פונקציית התקשרות חוזרת שנוספה בעבר דרך IdChangeCallbackFn . |
פונקציה (אפליקציה,...)
getInstallations(אפליקציה)
מחזיר מופע של התקנות המשויך למופע הנתון של FirebaseApp .
חֲתִימָה:
export declare function getInstallations(app?: FirebaseApp): Installations;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אפליקציה | FirebaseApp | המופע של FirebaseApp . |
החזרות:
פונקציה (התקנות,...)
מחק התקנות (התקנות)
מוחק את התקנת Firebase ואת כל הנתונים המשויכים.
חֲתִימָה:
export declare function deleteInstallations(installations: Installations): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
התקנות | התקנות | מופע Installations . |
החזרות:
הבטחה<void>
getId(installations)
יוצר התקנה של Firebase אם אין כזו עבור האפליקציה ומחזיר את מזהה ההתקנה.
חֲתִימָה:
export declare function getId(installations: Installations): Promise<string>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
התקנות | התקנות | מופע Installations . |
החזרות:
הבטחה<string>
getToken(התקנות, forceRefresh)
מחזירה אסימון אישור של Firebase Installations, המזהה את התקנת Firebase הנוכחית.
חֲתִימָה:
export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
התקנות | התקנות | מופע Installations . |
כוחRefresh | בוליאני | כפה רענון ללא קשר לפקיעת האסימון. |
החזרות:
הבטחה<string>
onIdChange(התקנות, התקשרות חוזרת)
מגדיר התקשרות חוזרת חדשה שתיקרא כאשר מזהה ההתקנה משתנה. מחזירה פונקציית ביטול הרשמה שתסיר את ההתקשרות חזרה בעת ההתקשרות.
חֲתִימָה:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
התקנות | התקנות | מופע Installations . |
התקשר חזרה | IdChangeCallbackFn | פונקציית ההתקשרות חזרה המופעלת כאשר FID משתנה. |
החזרות:
פונקציה שניתן לקרוא לה כדי לבטל את המנוי.
IdChangeCallbackFn
פונקציית התקשרות חוזרת המוגדרת על ידי המשתמש הנקראת כאשר מזהה התקנות משתנה.
חֲתִימָה:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdChangeUnsubscribeFn
בטל את הרישום של פונקציית התקשרות חוזרת שנוספה בעבר דרך IdChangeCallbackFn .
חֲתִימָה:
export declare type IdChangeUnsubscribeFn = () => void;