remote-config package

Firebase Remote Config Web SDK. لا يعمل SDK هذا في بيئة Node.js.

المهام

وظيفة وصف
وظيفة (التطبيق، ...)
الحصول علىRemoteConfig(التطبيق)
وظيفة (التكوين عن بعد، ...)
تفعيل (التكوين عن بعد) يجعل آخر تكوين تم جلبه متاحًا للحاصلين على الرقم.
ضمان التهيئة (التكوين عن بعد) يضمن أن آخر تكوين تم تنشيطه متاح للحاصلين عليه.
جلب وتنشيط (التكوين عن بعد) ينفذ عمليات الجلب والتنشيط، كوسيلة راحة.
fetchConfig(remoteConfig) تكوين الجلب والتخزين المؤقت من خدمة التكوين عن بعد.
الحصول على الكل (التكوين عن بعد) يحصل على كل التكوين.
getBoolean(remoteConfig، مفتاح) يحصل على قيمة المفتاح المحدد كقيمة منطقية. طريقة ملائمة لاستدعاء remoteConfig.getValue(key).asBoolean() .
getNumber(remoteConfig، مفتاح) الحصول على قيمة المفتاح المحدد كرقم. طريقة ملائمة لاستدعاء remoteConfig.getValue(key).asNumber() .
getString(remoteConfig، مفتاح) يحصل على قيمة المفتاح المحدد كسلسلة. طريقة ملائمة لاستدعاء remoteConfig.getValue(key).asString() .
getValue(remoteConfig، مفتاح) يحصل على القيمة للمفتاح المحدد.
setLogLevel(remoteConfig, logLevel) يحدد مستوى السجل المراد استخدامه.
وظيفة()
مدعوم() توفر هذه الطريقة فحصين مختلفين: 1. تحقق من وجود IndexedDB في بيئة المتصفح. 2. تحقق مما إذا كان سياق المتصفح الحالي يسمح باستدعاءات IndexedDB open() .

واجهات

واجهه المستخدم وصف
التكوين البعيد واجهة خدمة Firebase Remote Config.
إعدادات التكوين عن بعد يحدد خيارات التكوين لـ Remote Config SDK.
قيمة يلتف القيمة ببيانات تعريفية وحروف كتابة آمنة.

اكتب الأسماء المستعارة

اكتب الاسم المستعار وصف
FetchStatus يلخص نتيجة المحاولة الأخيرة لجلب التكوين من خادم Firebase Remote Config.
  • يشير "no-fetch-yet" إلى أن مثيل RemoteConfig لم يحاول بعد جلب التكوين، أو أن تهيئة SDK غير مكتملة.
  • يشير "النجاح" إلى نجاح المحاولة الأخيرة.
  • يشير "الفشل" إلى فشل المحاولة الأخيرة.
  • يشير "الخانق" إلى أن المحاولة الأخيرة كانت محدودة المعدل.
تسجيل مستوى يحدد مستويات تسجيل التكوين عن بعد.
مصدر القيمة يشير إلى مصدر القيمة.
  • يشير "ثابت" إلى أن القيمة تم تعريفها بواسطة ثابت ثابت.
  • يشير "الافتراضي" إلى أن القيمة تم تحديدها بواسطة التكوين الافتراضي.
  • يشير "البعيد" إلى أن القيمة تم تحديدها بواسطة التكوين الذي تم جلبه.

وظيفة (التطبيق، ...)

الحصول علىRemoteConfig(التطبيق)

إمضاء:

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

حدود

معامل يكتب وصف
برنامج FirebaseApp مثيل FirebaseApp .

عائدات:

التكوين البعيد

مثيل RemoteConfig .

وظيفة (التكوين عن بعد، ...)

تفعيل (التكوين عن بعد)

يجعل آخر تكوين تم جلبه متاحًا للحاصلين على الرقم.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .

عائدات:

وعد <منطقي>

Promise يتحول إلى صحيح إذا قامت المكالمة الحالية بتنشيط التكوينات التي تم جلبها. إذا كانت التكوينات التي تم جلبها قد تم تنشيطها بالفعل، فسيتم تحويل Promise إلى خطأ.

ضمان التهيئة (التكوين عن بعد)

يضمن أن آخر تكوين تم تنشيطه متاح للحاصلين عليه.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .

عائدات:

وعد<باطل>

Promise يتم حله عندما يكون آخر تكوين تم تنشيطه متاحًا للحاصلين عليه.

جلب وتنشيط (التكوين عن بعد)

ينفذ عمليات الجلب والتنشيط، كوسيلة راحة.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .

عائدات:

وعد <منطقي>

Promise يتحول إلى صحيح إذا قامت المكالمة الحالية بتنشيط التكوينات التي تم جلبها. إذا كانت التكوينات التي تم جلبها قد تم تنشيطها بالفعل، فسيتم تحويل Promise إلى خطأ.

fetchConfig(remoteConfig)

تكوين الجلب والتخزين المؤقت من خدمة التكوين عن بعد.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .

عائدات:

وعد<باطل>

الحصول على الكل (التكوين عن بعد)

يحصل على كل التكوين.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .

عائدات:

سجل <سلسلة، القيمة >

كل التكوين.

getBoolean(remoteConfig، مفتاح)

يحصل على قيمة المفتاح المحدد كقيمة منطقية.

طريقة ملائمة لاستدعاء remoteConfig.getValue(key).asBoolean() .

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .
مفتاح خيط اسم المعامل.

عائدات:

منطقية

قيمة المفتاح المحدد كقيمة منطقية.

getNumber(remoteConfig، مفتاح)

الحصول على قيمة المفتاح المحدد كرقم.

طريقة ملائمة لاستدعاء remoteConfig.getValue(key).asNumber() .

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .
مفتاح خيط اسم المعامل.

عائدات:

رقم

قيمة المفتاح المحدد كرقم.

getString(remoteConfig، مفتاح)

يحصل على قيمة المفتاح المحدد كسلسلة. طريقة ملائمة لاستدعاء remoteConfig.getValue(key).asString() .

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .
مفتاح خيط اسم المعامل.

عائدات:

خيط

قيمة المفتاح المحدد كسلسلة.

getValue(remoteConfig، مفتاح)

يحصل على القيمة للمفتاح المحدد.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .
مفتاح خيط اسم المعامل.

عائدات:

قيمة

قيمة المفتاح المحدد.

setLogLevel(remoteConfig, logLevel)

يحدد مستوى السجل المراد استخدامه.

إمضاء:

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

حدود

معامل يكتب وصف
RemoteConfig التكوين البعيد مثيل RemoteConfig .
تسجيل مستوى RemoteConfigLogLevel مستوى السجل المراد ضبطه.

عائدات:

فارغ

وظيفة()

مدعوم()

توفر هذه الطريقة فحصين مختلفين:

  1. تحقق من وجود IndexedDB في بيئة المتصفح. 2. تحقق مما إذا كان سياق المتصفح الحالي يسمح باستدعاءات IndexedDB open() .

إمضاء:

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

عائدات:

وعد <منطقي>

Promise يتحول إلى صحيح إذا كان من الممكن تهيئة مثيل RemoteConfig في هذه البيئة، أو إلى خطأ إذا لم يكن من الممكن ذلك.

FetchStatus

يلخص نتيجة المحاولة الأخيرة لجلب التكوين من خادم Firebase Remote Config.

  • يشير "no-fetch-yet" إلى أن مثيل [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) لم يحاول بعد جلب التكوين، أو أن تهيئة SDK غير مكتملة.
  • يشير "النجاح" إلى نجاح المحاولة الأخيرة.
  • يشير "الفشل" إلى فشل المحاولة الأخيرة.
  • يشير "الخانق" إلى أن المحاولة الأخيرة كانت محدودة المعدل.

إمضاء:

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

تسجيل مستوى

يحدد مستويات تسجيل التكوين عن بعد.

إمضاء:

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

مصدر القيمة

يشير إلى مصدر القيمة.

  • يشير "ثابت" إلى أن القيمة تم تعريفها بواسطة ثابت ثابت.
  • يشير "الافتراضي" إلى أن القيمة تم تحديدها بواسطة التكوين الافتراضي.
  • يشير "البعيد" إلى أن القيمة تم تحديدها بواسطة التكوين الذي تم جلبه.

إمضاء:

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