remote-config package

حزمة تطوير البرامج (SDK) على الويب لميزة "الإعداد عن بُعد في Firebase" لا تعمل حزمة تطوير البرامج (SDK) هذه في بيئة Node.js.

الدوال

واجهات

كتابة العناوين البديلة للبريد الإلكتروني

function(app, ...)

getRemoteConfig(app)

Signature:

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

المَعلمات

المرتجعات:

الإعداد عن بُعد

مثيل RemoteConfig.

function(remoteConfig, ...)

تفعيل(remoteConfig)

يجعل هذا الإعداد آخر إعداد تم استرجاعه متاحًا للمُستلمين.

Signature:

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

المَعلمات

المرتجعات:

Promise<boolean>

يتم ضبط Promise على "صحيح" إذا فعَّلت المكالمة الحالية الإعدادات التي تم استرجاعها. إذا سبق أن تم تفعيل الإعدادات التي تم استرجاعها، سيتم ضبط قيمة Promise على "خطأ".

التأكّد من ضبط الإعداد(عن بُعد)

يضمن توفُّر آخر إعداد نشط للمستخدمين.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

Promise الذي يتم حله عند توفُّر آخر إعداد نشط للمستخدمين.

getAndActivate(remoteConfig)

تنفيذ عمليات الاسترجاع وتفعيلها لتسهيل عملية العثور عليها

Signature:

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

المَعلمات

المرتجعات:

Promise&lt;boolean&gt;

يتم ضبط Promise على "صحيح" إذا فعَّلت المكالمة الحالية الإعدادات التي تم استرجاعها. إذا سبق أن تم تفعيل الإعدادات التي تم استرجاعها، سيتم ضبط قيمة Promise على "خطأ".

getConfig(remoteConfig)

يجلب الإعدادات ويخزنها مؤقتًا من خدمة "الإعداد عن بُعد".

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

getAll(remoteConfig)

الحصول على جميع الإعدادات.

Signature:

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

المَعلمات

المرتجعات:

Record<string, Value>

جميع الإعدادات.

getBoolean(remoteConfig, key)

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

طريقة سهلة للاتصال بـ remoteConfig.getValue(key).asBoolean().

Signature:

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

المَعلمات

المرتجعات:

قيمة منطقية

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

getNumber(remoteConfig, key)

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

طريقة سهلة للاتصال بـ remoteConfig.getValue(key).asNumber().

Signature:

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

المَعلمات

المرتجعات:

رقم

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

getString(remoteConfig, key)

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

Signature:

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

المَعلمات

المرتجعات:

السلسلة

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

getValue(remoteConfig, key)

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

Signature:

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

المَعلمات

المرتجعات:

القيمة

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

setLogLevel(remoteConfig،, LogLevel)

يحدِّد مستوى السجلّ المطلوب استخدامه.

Signature:

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

المَعلمات

المرتجعات:

فراغ

الدالة()

issupported()

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

1. تحقَّق من توفُّر IndexedDB في بيئة المتصفِّح. 2- تأكَّد مما إذا كان سياق المتصفّح الحالي يسمح باستدعاءات IndexedDB open().

Signature:

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

المرتجعات:

Promise&lt;boolean&gt;

يشير ذلك المصطلح إلى Promise الذي يتم ضبطه على القيمة "صحيح" إذا كان من الممكن إعداد مثيل RemoteConfig في هذه البيئة، أو على "false" إذا تعذّر ذلك.

حالة الجلب

يلخّص نتيجة آخر محاولة لاسترجاع الإعدادات من خادم "الإعداد عن بُعد في Firebase".

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

Signature:

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

مستوى السجلّ

تحدِّد هذه السياسة مستويات التسجيل في ميزة "الإعداد عن بُعد".

Signature:

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

مصدر القيمة

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

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

Signature:

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