firebase-admin.remote-config package

תצורה מרחוק של Firebase.

פונקציות

פוּנקצִיָה תיאור
getRemoteConfig(app) מקבל את שירות RemoteConfig עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא getRemoteConfig() ללא ארגומנטים לגישה לשירות RemoteConfig של אפליקציית ברירת המחדל או בתור getRemoteConfig(app) כדי לגשת לשירות RemoteConfig המשויך לאפליקציה ספציפית.

שיעורים

מעמד תיאור
RemoteConfig ממשק שירות Firebase RemoteConfig .

ממשקים

מִמְשָׁק תיאור
ExplicitParameterValue ממשק המייצג ערך פרמטר מפורש.
InAppDefaultValue ממשק המייצג ערך ברירת מחדל בתוך האפליקציה.
ListVersionsOptions ממשק המייצג אפשרויות לפעולת גרסאות תצורה מרחוק.
ListVersionsResult ממשק המייצג רשימה של גרסאות תבנית תצורה מרוחקת.
RemoteConfigCondition ממשק המייצג מצב תצורה מרחוק. תנאי ממקד לקבוצה ספציפית של משתמשים. רשימה של תנאים אלה מהווה חלק מתבנית תצורה מרחוק.
RemoteConfigParameter ממשק המייצג פרמטר Config מרחוק. לכל הפחות, ערך defaultValue או conditionalValues ​​חייב להיות נוכח כדי שהפרמטר ישפיע.
RemoteConfigParameterGroup ממשק המייצג קבוצת פרמטרים של תצורה מרוחקת. קיבוץ פרמטרים מיועד רק למטרות ניהול ואינו משפיע על שליפת ערכי פרמטרים בצד הלקוח.
RemoteConfigTemplate ממשק המייצג תבנית תצורה מרוחקת.
RemoteConfigUser ממשק המייצג משתמש Config מרחוק.
גִרְסָה ממשק המייצג גרסת תבנית תצורה מרוחקת. פלט בלבד, למעט תיאור הגרסה. מכיל מטא נתונים לגבי גרסה מסוימת של תבנית התצורה המרוחקת. כל השדות מוגדרים בזמן פרסום תבנית התצורה המרוחקת שצוינה. ניתן לציין שדה תיאור של גרסה בקריאות publishTemplate .

הקלד כינויים

הקלד כינוי תיאור
ParameterValueType סוג המייצג סוג נתונים של ערך פרמטר Config Remote. ברירת המחדל היא STRING אם לא צוין.
RemoteConfigParameterValue סוג המייצג ערך של פרמטר Config מרחוק. RemoteConfigParameterValue יכול להיות ExplicitParameterValue או InAppDefaultValue .
TagColor צבעים המשויכים לתנאים למטרות תצוגה.

getRemoteConfig()

מקבל את שירות RemoteConfig עבור אפליקציית ברירת המחדל או אפליקציה נתונה.

ניתן לקרוא getRemoteConfig() ללא ארגומנטים לגישה לשירות RemoteConfig של אפליקציית ברירת המחדל או בתור getRemoteConfig(app) כדי לגשת לשירות RemoteConfig המשויך לאפליקציה ספציפית.

חֲתִימָה:

export declare function getRemoteConfig(app?: App): RemoteConfig;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה אפליקציה אפליקציה אופציונלית שעבורה ניתן להחזיר את שירות RemoteConfig . אם לא מסופק, שירות RemoteConfig המוגדר כברירת מחדל מוחזר.

החזרות:

RemoteConfig

שירות RemoteConfig המוגדר כברירת מחדל אם לא מסופקת אפליקציה, או שירות RemoteConfig המשויך לאפליקציה שסופקה.

דוגמה 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

דוגמה 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

ParameterValueType

סוג המייצג סוג נתונים של ערך פרמטר Config Remote. ברירת המחדל היא STRING אם לא צוין.

חֲתִימָה:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

RemoteConfigParameterValue

סוג המייצג ערך של פרמטר Config מרחוק. RemoteConfigParameterValue יכול להיות ExplicitParameterValue או InAppDefaultValue .

חֲתִימָה:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

TagColor

צבעים המשויכים לתנאים למטרות תצוגה.

חֲתִימָה:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';