remote-config package

Firebase Remote Config Web SDK. SDK זה לא עובד בסביבת Node.js.

פונקציות

פוּנקצִיָה תיאור
פונקציה (אפליקציה,...)
getRemoteConfig(app)
function (remoteConfig, ...)
active(remoteConfig) הופך את התצורה האחרונה שאוחזרה לזמינה למקבלים.
sureInitialized(remoteConfig) מוודא שהתצורה האחרונה שהופעלה זמינה למקבלים.
fetchAndActivate(remoteConfig) מבצע פעולות אחזור והפעלה, מטעמי נוחות.
fetchConfig(remoteConfig) תצורת מאחזר וקובץ מטמון משירות התצורה המרוחקת.
getAll(remoteConfig) מקבל את כל התצורה.
getBoolean(remoteConfig, key) מקבל את הערך עבור המפתח הנתון בתור בוליאני. שיטת נוחות לקריאה ל- remoteConfig.getValue(key).asBoolean() .
getNumber(remoteConfig, key) מקבל את הערך עבור המפתח הנתון כמספר. שיטת נוחות לקריאה ל- remoteConfig.getValue(key).asNumber() .
getString(remoteConfig, key) מקבל את הערך עבור המפתח הנתון כמחרוזת. שיטת נוחות לקריאה ל- remoteConfig.getValue(key).asString() .
getValue(remoteConfig, key) מקבל את הערך עבור המפתח הנתון.
setLogLevel(remoteConfig, logLevel) מגדיר את רמת היומן לשימוש.
פוּנקצִיָה()
נתמך() שיטה זו מספקת שתי בדיקות שונות: 1. בדוק אם IndexedDB קיים בסביבת הדפדפן. 2. בדוק אם ההקשר הנוכחי של הדפדפן מאפשר קריאות של IndexedDB open() ‎.

ממשקים

מִמְשָׁק תיאור
RemoteConfig ממשק השירות של Firebase Remote Config.
RemoteConfigSettings מגדיר אפשרויות תצורה עבור ה-Remote Config SDK.
ערך עוטף ערך עם מטא-נתונים וגטר-בטוחים.

הקלד כינויים

הקלד כינוי תיאור
FetchStatus מסכם את התוצאה של הניסיון האחרון להביא תצורה משרת התצורה המרוחק של Firebase.
  • "no-fetch-yet" מציין שמופע RemoteConfig עדיין לא ניסה להביא תצורה, או שאתחול SDK אינו שלם.
  • "הצלחה" מציין שהניסיון האחרון הצליח.
  • "כשל" מציין שהניסיון האחרון נכשל.
  • "מצערת" מציין שהניסיון האחרון היה מוגבל בקצב.
LogLevel מגדיר רמות של רישום תצורה מרחוק.
ValueSource מציין את המקור של ערך.
  • "סטטי" מציין שהערך הוגדר על ידי קבוע סטטי.
  • "ברירת מחדל" מציין שהערך הוגדר כברירת מחדל.
  • "מרוחק" מציין שהערך הוגדר על ידי תצורה אחזרה.

פונקציה (אפליקציה,...)

getRemoteConfig(app)

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה FirebaseApp מופע FirebaseApp .

החזרות:

RemoteConfig

מופע RemoteConfig .

function (remoteConfig, ...)

active(remoteConfig)

הופך את התצורה האחרונה שאוחזרה לזמינה למקבלים.

חֲתִימָה:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .

החזרות:

הבטחה<בוליאנית>

Promise שנפתרת לאמת אם השיחה הנוכחית הפעילה את התצורות שהובאו. אם ההגדרות שהובאו כבר הופעלו, Promise תפתור לשווא.

sureInitialized(remoteConfig)

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

חֲתִימָה:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .

החזרות:

הבטחה<void>

Promise שנפתרת כאשר התצורה שהופעלה אחרונה זמינה למקבלים.

fetchAndActivate(remoteConfig)

מבצע פעולות אחזור והפעלה, מטעמי נוחות.

חֲתִימָה:

export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .

החזרות:

הבטחה<בוליאנית>

Promise שנפתרת לאמת אם השיחה הנוכחית הפעילה את התצורות שהובאו. אם ההגדרות שהובאו כבר הופעלו, Promise תפתור לשווא.

fetchConfig(remoteConfig)

תצורת מאחזר וקובץ מטמון משירות התצורה המרוחקת.

חֲתִימָה:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .

החזרות:

הבטחה<void>

getAll(remoteConfig)

מקבל את כל התצורה.

חֲתִימָה:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .

החזרות:

הקלטה<string, Value >

כל התצורה.

getBoolean(remoteConfig, key)

מקבל את הערך עבור המפתח הנתון בתור בוליאני.

שיטת נוחות לקריאה ל- remoteConfig.getValue(key).asBoolean() .

חֲתִימָה:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .
מַפְתֵחַ חוּט שם הפרמטר.

החזרות:

בוליאני

הערך עבור המפתח הנתון בתור בוליאני.

getNumber(remoteConfig, key)

מקבל את הערך עבור המפתח הנתון כמספר.

שיטת נוחות לקריאה ל- remoteConfig.getValue(key).asNumber() .

חֲתִימָה:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .
מַפְתֵחַ חוּט שם הפרמטר.

החזרות:

מספר

הערך של המפתח הנתון כמספר.

getString(remoteConfig, key)

מקבל את הערך עבור המפתח הנתון כמחרוזת. שיטת נוחות לקריאה ל- remoteConfig.getValue(key).asString() .

חֲתִימָה:

export declare function getString(remoteConfig: RemoteConfig, key: string): string;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .
מַפְתֵחַ חוּט שם הפרמטר.

החזרות:

חוּט

הערך עבור המפתח הנתון כמחרוזת.

getValue(remoteConfig, key)

מקבל את הערך עבור המפתח הנתון.

חֲתִימָה:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .
מַפְתֵחַ חוּט שם הפרמטר.

החזרות:

ערך

הערך עבור המפתח הנתון.

setLogLevel(remoteConfig, logLevel)

מגדיר את רמת היומן לשימוש.

חֲתִימָה:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
remoteconfig RemoteConfig מופע RemoteConfig .
logLevel RemoteConfigLogLevel רמת היומן שיש להגדיר.

החזרות:

בָּטֵל

פוּנקצִיָה()

נתמך()

שיטה זו מספקת שתי בדיקות שונות:

  1. בדוק אם IndexedDB קיים בסביבת הדפדפן. 2. בדוק אם ההקשר הנוכחי של הדפדפן מאפשר קריאות של IndexedDB open() ‎.

חֲתִימָה:

export declare function isSupported(): Promise<boolean>;

החזרות:

הבטחה<בוליאנית>

Promise שנפתרת ל-true אם ניתן לאתחל מופע RemoteConfig בסביבה זו, או שקר אם לא.

FetchStatus

מסכם את התוצאה של הניסיון האחרון להביא תצורה משרת התצורה המרוחקת של Firebase.

  • "no-fetch-yet" מציין שהמופע [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) לא ניסה עדיין לאחזר תצורה, או שאתחול SDK אינו שלם.
  • "הצלחה" מציין שהניסיון האחרון הצליח.
  • "כשל" מציין שהניסיון האחרון נכשל.
  • "מצערת" מציין שהניסיון האחרון היה מוגבל בקצב.

חֲתִימָה:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

LogLevel

מגדיר רמות של רישום תצורה מרחוק.

חֲתִימָה:

export declare type LogLevel = 'debug' | 'error' | 'silent';

ValueSource

מציין את המקור של ערך.

  • "סטטי" מציין שהערך הוגדר על ידי קבוע סטטי.
  • "ברירת מחדל" מציין שהערך הוגדר כברירת מחדל.
  • "מרוחק" מציין שהערך הוגדר על ידי תצורה אחזרה.

חֲתִימָה:

export declare type ValueSource = 'static' | 'default' | 'remote';