remote-config package

Firebase Remote Config Web SDK. این SDK در محیط Node.js کار نمی کند.

کارکرد

تابع شرح
عملکرد (برنامه، ...)
getRemoteConfig (برنامه)
تابع (RemoteConfig، ...)
فعال کردن (RemoteConfig) آخرین پیکربندی واکشی شده را در دسترس گیرندگان قرار می دهد.
sureInitialized (RemoteConfig) اطمینان حاصل می کند که آخرین پیکربندی فعال شده در دسترس گیرندگان است.
fetchAndActivate(remoteConfig) عملیات واکشی و فعال سازی را برای راحتی انجام می دهد.
fetchConfig(remoteConfig) واکشی و پیکربندی حافظه پنهان از سرویس Remote Config.
getAll (remoteConfig) تمام تنظیمات را دریافت می کند.
getBoolean (remoteConfig، کلید) مقدار کلید داده شده را به صورت بولی دریافت می کند. روش راحت برای فراخوانی remoteConfig.getValue(key).asBoolean() .
getNumber (remoteConfig، کلید) مقدار کلید داده شده را به صورت عدد دریافت می کند. روش راحت برای فراخوانی remoteConfig.getValue(key).asNumber() .
getString (remoteConfig، کلید) مقدار کلید داده شده را به عنوان یک رشته دریافت می کند. روش راحت برای فراخوانی remoteConfig.getValue(key).asString() .
getValue (remoteConfig، کلید) مقدار کلید داده شده را دریافت می کند.
setLogLevel (remoteConfig، logLevel) سطح گزارش را برای استفاده تعریف می کند.
تابع()
isSupported() این روش دو بررسی مختلف را ارائه می دهد: 1. بررسی کنید که آیا IndexedDB در محیط مرورگر وجود دارد یا خیر. 2. بررسی کنید که آیا زمینه مرورگر فعلی اجازه open() IndexedDB را می دهد یا خیر.

رابط ها

رابط شرح
RemoteConfig رابط سرویس Firebase Remote Config.
RemoteConfigSettings گزینه های پیکربندی را برای Remote Config SDK تعریف می کند.
ارزش یک مقدار را با فراداده و دریافت کننده های ایمن نوع بسته بندی می کند.

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
FetchStatus نتیجه آخرین تلاش برای واکشی پیکربندی از سرور Firebase Remote Config را خلاصه می کند.
  • "no-fetch-yet" نشان می دهد که نمونه RemoteConfig هنوز تلاشی برای واکشی پیکربندی نکرده است، یا اینکه مقداردهی اولیه SDK ناقص است.
  • "موفقیت" نشان دهنده آخرین تلاش موفقیت آمیز است.
  • "شکست" نشان می دهد که آخرین تلاش شکست خورده است.
  • "دریچه گاز" نشان می دهد که آخرین تلاش با نرخ محدود بوده است.
LogLevel سطوح ثبت پیکربندی از راه دور را تعریف می کند.
منبع ارزش منبع یک مقدار را نشان می دهد.
  • "static" نشان می دهد که مقدار با یک ثابت استاتیک تعریف شده است.
  • "default" نشان می دهد که مقدار توسط پیکربندی پیش فرض تعریف شده است.
  • "Remote" نشان می دهد که مقدار توسط پیکربندی واکشی شده تعریف شده است.

عملکرد (برنامه، ...)

getRemoteConfig (برنامه)

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App نمونه FirebaseApp .

برمی‌گرداند:

RemoteConfig

یک نمونه RemoteConfig .

تابع (RemoteConfig، ...)

فعال کردن (RemoteConfig)

آخرین پیکربندی واکشی شده را در دسترس گیرندگان قرار می دهد.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .

برمی‌گرداند:

وعده<boolean>

یک Promise که اگر تماس فعلی پیکربندی‌های واکشی شده را فعال کند، به درستی تبدیل می‌شود. اگر تنظیمات واکشی شده قبلاً فعال شده باشند، Promise به false تبدیل می شود.

sureInitialized (RemoteConfig)

اطمینان حاصل می کند که آخرین پیکربندی فعال شده در دسترس گیرندگان است.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .

برمی‌گرداند:

قول<باطل>

یک Promise که زمانی حل می شود که آخرین پیکربندی فعال شده در دسترس گیرندگان باشد.

fetchAndActivate(remoteConfig)

عملیات واکشی و فعال سازی را برای راحتی انجام می دهد.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .

برمی‌گرداند:

وعده<boolean>

یک Promise که اگر تماس فعلی پیکربندی‌های واکشی شده را فعال کند، به درستی تبدیل می‌شود. اگر تنظیمات واکشی شده قبلاً فعال شده باشند، Promise به false تبدیل می شود.

fetchConfig(remoteConfig)

واکشی و پیکربندی حافظه پنهان از سرویس Remote Config.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .

برمی‌گرداند:

قول<باطل>

getAll (remoteConfig)

تمام تنظیمات را دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .

برمی‌گرداند:

Record<string, Value >

تمام تنظیمات

getBoolean (remoteConfig، کلید)

مقدار کلید داده شده را به صورت بولی دریافت می کند.

روش راحت برای فراخوانی remoteConfig.getValue(key).asBoolean() .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .
کلید رشته نام پارامتر.

برمی‌گرداند:

بولی

مقدار برای کلید داده شده به عنوان یک بولی.

getNumber (remoteConfig، کلید)

مقدار کلید داده شده را به صورت عدد دریافت می کند.

روش راحت برای فراخوانی remoteConfig.getValue(key).asNumber() .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .
کلید رشته نام پارامتر.

برمی‌گرداند:

عدد

مقدار برای کلید داده شده به عنوان یک عدد.

getString (remoteConfig، کلید)

مقدار کلید داده شده را به عنوان یک رشته دریافت می کند. روش راحت برای فراخوانی remoteConfig.getValue(key).asString() .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
remoteConfig RemoteConfig نمونه RemoteConfig .
کلید رشته نام پارامتر.

برمی‌گرداند:

رشته

مقدار برای کلید داده شده به عنوان یک رشته.

getValue (remoteConfig، کلید)

مقدار کلید داده شده را دریافت می کند.

امضا:

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 سطح گزارش برای تنظیم.

برمی‌گرداند:

خالی

تابع()

isSupported()

این روش دو بررسی مختلف را ارائه می دهد:

  1. بررسی کنید که آیا IndexedDB در محیط مرورگر وجود دارد یا خیر. 2. بررسی کنید که آیا زمینه مرورگر فعلی اجازه open() IndexedDB را می دهد یا خیر.

امضا:

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

برمی‌گرداند:

وعده<boolean>

یک Promise که اگر یک نمونه RemoteConfig را بتوان در این محیط مقداردهی کرد، به true یا اگر نتواند، false می شود.

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';

LogLevel

سطوح ثبت پیکربندی از راه دور را تعریف می کند.

امضا:

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

منبع ارزش

منبع یک مقدار را نشان می دهد.

  • "static" نشان می دهد که مقدار با یک ثابت استاتیک تعریف شده است.
  • "default" نشان می دهد که مقدار توسط پیکربندی پیش فرض تعریف شده است.
  • "Remote" نشان می دهد که مقدار توسط پیکربندی واکشی شده تعریف شده است.

امضا:

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