واجهة خدمة RemoteConfig في Firebase
Signature:
export declare class RemoteConfig
أماكن إقامة
| الموقع | المعدِّلات | Type | الوصف |
|---|---|---|---|
| تطبيق | التطبيق |
الطُرق
| الطريقة | المعدِّلات | الوصف |
|---|---|---|
| createTemplateFromJSON(json) | تنشئ هذه الدالة نموذجًا جديدًا عن "الإعداد عن بُعد" ويعرضه من سلسلة JSON. | |
| getServerTemplate(options) | إنشاء نسخة افتراضية لـ ServerTemplate، ثم جلب أحدث إصدار نموذج من المشروع وتخزينه مؤقتًا. | |
| getTemplate() | الحصول على الإصدار النشط الحالي من RemoteConfigTemplate للمشروع | |
| getTemplateAtVersion(versionNumber) | الحصول على الإصدار المطلوب من RemoteConfigTemplate من المشروع. | |
| initServerTemplate(options) | إنشاء مثيل لـ ServerTemplate بشكل متزامن. | |
| listVersions(options) | يمكنك الحصول على قائمة بإصدارات نماذج "الإعداد عن بُعد" التي تم نشرها، مع ترتيبها بترتيب زمني عكسي. لا يتم تخزين سوى آخر 300 نسخة. ويتم أيضًا حذف جميع الإصدارات المتوافقة مع نماذج "الإعداد عن بُعد" غير النشطة (أي أنّها كلها باستثناء النموذج الذي يجلبه العملاء) إذا كانت أقدم من 90 يومًا. | |
| publishTemplate(template, options) | نشر نموذج لميزة "الإعداد عن بُعد" | |
| rollback(versionNumber) | يؤدي هذا الإجراء إلى إرجاع نموذج "الإعداد عن بُعد" المنشور للمشروع إلى الإصدار المحدَّد. تعادل العودة إلى الحالة السابقة الحصول على نموذج تم نشره سابقًا من خلال ميزة "الإعداد عن بُعد" وإعادة نشره من خلال فرض تحديث. | |
| التحقّق من صحة النموذج(template) | يتحقّق من صحة RemoteConfigTemplate. |
تطبيق RemoteConfig.app
Signature:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
تنشئ هذه الدالة نموذجًا جديدًا عن "الإعداد عن بُعد" ويعرضه من سلسلة JSON.
Signature:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| ملف JSON | سلسلة | سلسلة JSON لتعبئة نموذج "الإعداد عن بُعد" |
المرتجعات:
مثيل نموذج جديد
RemoteConfig.getServerTemplate()
إنشاء نسخة افتراضية لـ ServerTemplate، ثم جلب أحدث إصدار نموذج من المشروع وتخزينه مؤقتًا.
Signature:
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| خيارات | GetServerTemplateOptions |
المرتجعات:
الوعد<ServerTemplate>
RemoteConfig.getTemplate()
الحصول على الإصدار النشط الحالي من RemoteConfigTemplate للمشروع
Signature:
getTemplate(): Promise<RemoteConfigTemplate>;
المرتجعات:
الوعد<RemoteConfigTemplate>
وعدٍ يتم الوفاء به من خلال RemoteConfigTemplate.
RemoteConfig.getTemplateAtVersion()
الحصول على الإصدار المطلوب من RemoteConfigTemplate من المشروع.
Signature:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| رقم الإصدار | عدد | سلسلة | رقم إصدار نموذج "الإعداد عن بُعد" المطلوب البحث عنه |
المرتجعات:
الوعد<RemoteConfigTemplate>
وعدٍ يتم الوفاء به من خلال RemoteConfigTemplate.
RemoteConfig.initServerTemplate()
إنشاء مثيل لـ ServerTemplate بشكل متزامن.
Signature:
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| خيارات | InitServerTemplateOptions |
المرتجعات:
RemoteConfig.listVersions()
يمكنك الحصول على قائمة بإصدارات نماذج "الإعداد عن بُعد" التي تم نشرها، مع ترتيبها بترتيب زمني عكسي. لا يتم تخزين سوى آخر 300 نسخة. ويتم أيضًا حذف جميع الإصدارات المتوافقة مع نماذج "الإعداد عن بُعد" غير النشطة (أي أنّها كلها باستثناء النموذج الذي يجلبه العملاء) إذا كانت أقدم من 90 يومًا.
Signature:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| خيارات | ListVersionsOptions | عنصر خيارات اختياري للحصول على قائمة بالإصدارات |
المرتجعات:
الوعد<ListVersionsResult>
وعدٍ يتم الوفاء به من خلال ListVersionsResult.
RemoteConfig.publishTemplate()
نشر نموذج لميزة "الإعداد عن بُعد"
Signature:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| نموذج | RemoteConfigTemplate | نموذج "الإعداد عن بُعد" المطلوب نشره |
| خيارات | { فرض: القيمة المنطقية؛ } | عنصر خيارات اختياري عند نشر نموذج "الإعداد عن بُعد": - force: يؤدي ضبط هذا الإعداد على true إلى فرض تعديل نموذج "الإعداد عن بُعد" والتحايل على علامة ETag. لا يُنصح باستخدام هذا الأسلوب لأنّه يؤدي إلى فقدان تحديثات نموذج "الإعداد عن بُعد" إذا كان هناك عدة عملاء يعدّلون نموذج "الإعداد عن بُعد". يُرجى الاطّلاع على استخدام ETag والتحديثات المفروضة. |
المرتجعات:
الوعد<RemoteConfigTemplate>
وعد يتماشى مع RemoteConfigTemplate المنشورة.
RemoteConfig.rollback()
يؤدي هذا الإجراء إلى إرجاع نموذج "الإعداد عن بُعد" المنشور للمشروع إلى الإصدار المحدَّد. تعادل العودة إلى الحالة السابقة الحصول على نموذج تم نشره سابقًا من خلال ميزة "الإعداد عن بُعد" وإعادة نشره من خلال فرض تحديث.
Signature:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| رقم الإصدار | عدد | سلسلة | رقم إصدار نموذج "الإعداد عن بُعد" المطلوب العودة إليه يجب أن يكون رقم الإصدار المحدد أقل من رقم الإصدار الحالي، ولم يتم حذفه بسبب تلفه. لا يتم تخزين سوى آخر 300 نسخة. ويتم أيضًا حذف جميع الإصدارات المتوافقة مع نماذج "الإعداد عن بُعد" غير النشطة (أي كل النماذج باستثناء النموذج الذي يجلبه العملاء) إذا كان مرَّ أكثر من 90 يومًا. |
المرتجعات:
الوعد<RemoteConfigTemplate>
وعدًا يفي بسياسة RemoteConfigTemplate المنشورة.
RemoteConfig.recognizedTemplate()
يتحقّق من صحة RemoteConfigTemplate.
Signature:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
المَعلمات
| المَعلمة | Type | الوصف |
|---|---|---|
| نموذج | RemoteConfigTemplate | نموذج "الإعداد عن بُعد" المطلوب التحقّق منه |
المرتجعات:
الوعد<RemoteConfigTemplate>
تعهُّد بأنّك تفي بسياسة RemoteConfigTemplate التي تم التحقّق من صحتها.