RemoteConfig class

واجهة خدمة Firebase RemoteConfig.

Signature:

export declare class RemoteConfig 

أماكن إقامة

الموقع المعدِّلات النوع الوصف
التطبيق التطبيق

الطُرق

الطريقة المعدِّلات الوصف
createTemplateFromJSON(json) تنشئ هذه الطريقة نموذج "الإعداد عن بُعد" الجديد وتعرضه من سلسلة JSON.
getServerTemplate(options) ينشئ مثيل ServerTemplate ثم يجلب أحدث إصدار من النموذج للمشروع ويخزّنه مؤقتًا.
getTemplate() للحصول على الإصدار النشط الحالي من RemoteConfigTemplate للمشروع.
getTemplateAtVersion(versionNumber) الحصول على الإصدار المطلوب من RemoteConfigTemplate للمشروع.
initServerTemplate(options) ينشئ مثيل ServerTemplate بشكلٍ متزامن.
listVersions(options) للحصول على قائمة بإصدارات نماذج "الإعداد عن بُعد" التي تم نشرها، مع ترتيبها بترتيب زمني عكسي. ويتم تخزين آخر 300 نسخة فقط. يتم أيضًا حذف جميع الإصدارات المتوافقة مع نماذج "الإعداد عن بُعد" غير النشطة (أي جميعها باستثناء النموذج الذي يجلبه العملاء) إذا مرَّ عليها أكثر من 90 يومًا.
publishTemplate(template, options) نشر نموذج "الإعداد عن بُعد"
rollback(versionNumber) يؤدي هذا الإجراء إلى إعادة نموذج "الإعداد عن بُعد" المنشور للمشروع إلى الإصدار المحدَّد. تعادل العودة إلى الإصدارات السابقة الحصول على نموذج "الإعداد عن بُعد" تم نشره سابقًا وإعادة نشره باستخدام فرض تحديث.
VerifyateTemplate(template) يتحقق من صحة RemoteConfigTemplate.

تطبيق RemoteConfig.app

Signature:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

تنشئ هذه الطريقة نموذج "الإعداد عن بُعد" الجديد وتعرضه من سلسلة JSON.

Signature:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

المَعلمات

المعلمة النوع الوصف
ملف JSON السلسلة سلسلة JSON لتعبئة نموذج "الإعداد عن بُعد"

المرتجعات:

RemoteConfigTemplate

مثيل نموذج جديد.

RemoteConfig.getServerTemplate()

ينشئ مثيل ServerTemplate ثم يجلب أحدث إصدار من النموذج للمشروع ويخزّنه مؤقتًا.

Signature:

getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;

المَعلمات

المعلمة النوع الوصف
خيارات GetServerTemplateOptions

المرتجعات:

وعد <ServerTemplate>

RemoteConfig.getTemplate()

للحصول على الإصدار النشط الحالي من RemoteConfigTemplate للمشروع.

Signature:

getTemplate(): Promise<RemoteConfigTemplate>;

المرتجعات:

وعد <RemoteConfigTemplate>

الوعد الذي يتم الوفاء به من خلال RemoteConfigTemplate

RemoteConfig.getTemplateAtVersion()

الحصول على الإصدار المطلوب من RemoteConfigTemplate للمشروع.

Signature:

getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;

المَعلمات

المعلمة النوع الوصف
رقم الإصدار الرقم | سلسلة رقم إصدار نموذج "الإعداد عن بُعد" المطلوب البحث عنه

المرتجعات:

وعد <RemoteConfigTemplate>

الوعد الذي يتم الوفاء به من خلال RemoteConfigTemplate

RemoteConfig.initServerTemplate()

ينشئ مثيل ServerTemplate بشكلٍ متزامن.

Signature:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

المَعلمات

المعلمة النوع الوصف
خيارات InitServerTemplateOptions

المرتجعات:

ServerTemplate

RemoteConfig.listVersions()

للحصول على قائمة بإصدارات نماذج "الإعداد عن بُعد" التي تم نشرها، مع ترتيبها بترتيب زمني عكسي. ويتم تخزين آخر 300 نسخة فقط. يتم أيضًا حذف جميع الإصدارات المتوافقة مع نماذج "الإعداد عن بُعد" غير النشطة (أي جميعها باستثناء النموذج الذي يجلبه العملاء) إذا مرَّ عليها أكثر من 90 يومًا.

Signature:

listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;

المَعلمات

المعلمة النوع الوصف
خيارات ListVersionsOptions كائن خيارات اختياري للحصول على قائمة بالإصدارات.

المرتجعات:

الوعد<ListVersionsResult>

الوعد الذي يفي باستخدام ListVersionsResult

RemoteConfig.publishTemplate()

نشر نموذج "الإعداد عن بُعد"

Signature:

publishTemplate(template: RemoteConfigTemplate, options?: {
        force: boolean;
    }): Promise<RemoteConfigTemplate>;

المَعلمات

المعلمة النوع الوصف
نموذج RemoteConfigTemplate نموذج "الإعداد عن بُعد" المطلوب نشره
خيارات { force: boolean; } عنصر الخيارات الاختيارية عند نشر نموذج "الإعداد عن بُعد": - force: يؤدي ضبط هذا الخيار على true إلى فرض تعديل نموذج "الإعداد عن بُعد" والتحايل على علامة ETag. ولا يُنصح باستخدام هذه الطريقة لأنها تهدد بفقدان تحديثات نموذج "الإعداد عن بُعد" في حال تعديل برامج متعددة لنموذج "الإعداد عن بُعد". راجِع استخدام ETag وفرض التعديلات.

المرتجعات:

وعد <RemoteConfigTemplate>

الوعد الذي يتم الوفاء به مع RemoteConfigTemplate المنشورة

RemoteConfig.rollback()

يؤدي هذا الإجراء إلى إعادة نموذج "الإعداد عن بُعد" المنشور للمشروع إلى الإصدار المحدَّد. تعادل العودة إلى الإصدارات السابقة الحصول على نموذج "الإعداد عن بُعد" تم نشره سابقًا وإعادة نشره باستخدام فرض تحديث.

Signature:

rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;

المَعلمات

المعلمة النوع الوصف
رقم الإصدار الرقم | سلسلة رقم إصدار نموذج "الإعداد عن بُعد" المطلوب العودة إليه يجب أن يكون رقم الإصدار المحدّد أقل من رقم الإصدار الحالي، وألا يتم حذفه بسبب قِدمه. ويتم تخزين آخر 300 نسخة فقط. يتم أيضًا حذف جميع الإصدارات التي تتوافق مع نماذج "الإعداد عن بُعد" غير النشطة (أي جميعها باستثناء النموذج الذي يجلبه العملاء) إذا كانت أقدم من 90 يومًا.

المرتجعات:

وعد <RemoteConfigTemplate>

الوفاء بالوعد الذي يتم الوفاء به مع RemoteConfigTemplate المنشورة

RemoteConfig.VerifyateTemplate()

يتحقق من صحة RemoteConfigTemplate.

Signature:

validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;

المَعلمات

المعلمة النوع الوصف
نموذج RemoteConfigTemplate يجب التحقّق من صحة نموذج "الإعداد عن بُعد".

المرتجعات:

وعد <RemoteConfigTemplate>

الوعد الذي يتم الوفاء به مع RemoteConfigTemplate التي تم التحقق منها