firebase-admin.remote-config package

Firebase रिमोट कॉन्फ़िगरेशन.

फ़ंक्शन

फ़ंक्शन ब्यौरा
getremoteConfig(ऐप्लिकेशन) यह नीति डिफ़ॉल्ट ऐप्लिकेशन या किसी ऐप्लिकेशन के लिए, RemoteConfig सेवा उपलब्ध कराती है. getRemoteConfig() को डिफ़ॉल्ट ऐप्लिकेशन की RemoteConfig सेवा को ऐक्सेस करने के लिए, बिना किसी तर्क के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी RemoteConfig सेवा को ऐक्सेस करने के लिए, getRemoteConfig(app) के तौर पर कॉल किया जा सकता है.

क्लास

क्लास ब्यौरा
रिमोट कॉन्फ़िगरेशन Firebase RemoteConfig सेवा का इंटरफ़ेस.

इन्यूमरेशन

इन्यूमरेशन ब्यौरा
PercentCondition ऑपरेटर प्रतिशत की शर्तों के लिए इस्तेमाल किए जा सकने वाले ऑपरेटर के बारे में बताता है.

इंटरफ़ेस

इंटरफ़ेस ब्यौरा
AndCondition यह उन शर्तों का कलेक्शन है जो सभी के सही होने पर, 'सही' के तौर पर मार्क होती हैं.
ExplicitParameterValue साफ़ तौर पर पैरामीटर वैल्यू दिखाने वाला इंटरफ़ेस.
GetServerTemplateOptions यह ऐसे वैकल्पिक आर्ग्युमेंट के बारे में बताता है जिनका इस्तेमाल ServerTemplate को इंस्टैंशिएट करते समय किया जा सकता है.
InAppDefaultValue ऐप्लिकेशन में डिफ़ॉल्ट तौर पर उपलब्ध वैल्यू को दिखाने वाला इंटरफ़ेस.
InitServerTemplateOptions यह ऐसे वैकल्पिक आर्ग्युमेंट के बारे में बताता है जिनका इस्तेमाल, सिंक्रोनस रूप से ServerTemplate को इंस्टैंशिएट करते समय किया जा सकता है.
ListVersionsOptions रिमोट कॉन्फ़िगरेशन की सूची के वर्शन से जुड़ी कार्रवाई के विकल्पों को दिखाने वाला इंटरफ़ेस.
ListVersionsनतीजे रिमोट कॉन्फ़िगरेशन टेंप्लेट के वर्शन की सूची दिखाने वाला इंटरफ़ेस.
माइक्रोPercentरेंज माइक्रो-प्रतिशत में टारगेट करने के लिए, पर्सेंटाइल की सीमा दिखाता है. मान [0 और 10,000,000] की सीमा में होना चाहिए
NamedCondition डेटाप्लेन में रिमोट कॉन्फ़िगरेशन की शर्त दिखाता है. शर्त, उपयोगकर्ताओं के खास ग्रुप को टारगेट करती है. इन शर्तों की एक सूची, रिमोट कॉन्फ़िगरेशन टेंप्लेट का हिस्सा है.
OneOfCondition यह ऐसी स्थिति को दिखाता है जो कई तरह की स्थितियों में से एक हो सकती है. सिर्फ़ सबसे पहले तय किए गए फ़ील्ड को ही प्रोसेस किया जाएगा.
OrCondition यह उन शर्तों का कलेक्शन है जो किसी भी स्थिति के सही होने पर उसका सही के तौर पर आकलन करती हैं.
PercentCondition यह ऐसी शर्त को दिखाता है जिसमें किसी दी गई सीमा से, इंस्टेंस की स्यूडो-रैंडम पर्सेंटाइल की तुलना की जाती है.
रिमोट कॉन्फ़िगरेशन की शर्त रिमोट कॉन्फ़िगरेशन की शर्त दिखाने वाला इंटरफ़ेस. शर्त, उपयोगकर्ताओं के खास ग्रुप को टारगेट करती है. इन शर्तों की एक सूची, रिमोट कॉन्फ़िगरेशन टेंप्लेट का हिस्सा है.
रिमोट कॉन्फ़िगरेशन पैरामीटर रिमोट कॉन्फ़िगरेशन पैरामीटर दिखाने वाला इंटरफ़ेस. पैरामीटर को असरदार बनाने के लिए, कम से कम defaultValue या conditionalValues एंट्री मौजूद होनी चाहिए.
रिमोट कॉन्फ़िगरेशन पैरामीटर ग्रुप रिमोट कॉन्फ़िगरेशन पैरामीटर के ग्रुप को दिखाने वाला इंटरफ़ेस. पैरामीटर को ग्रुप में रखने का काम सिर्फ़ मैनेजमेंट के लिए होता है. इससे पैरामीटर वैल्यू की क्लाइंट-साइड फ़ेच करने की सुविधा पर कोई असर नहीं पड़ता.
रिमोट कॉन्फ़िगरेशन टेंप्लेट यह रिमोट कॉन्फ़िगरेशन क्लाइंट टेंप्लेट को दिखाता है.
रिमोट कॉन्फ़िगरेशन उपयोगकर्ता रिमोट कॉन्फ़िगरेशन उपयोगकर्ता को दिखाने वाला इंटरफ़ेस.
सर्वर कॉन्फ़िगरेशन यह सर्वर टेंप्लेट का आकलन करके बनाए गए कॉन्फ़िगरेशन को दिखाता है.
ServerTemplate रिमोट कॉन्फ़िगरेशन सर्वर टेंप्लेट के लिए, स्टेटफ़ुल ऐब्स्ट्रैक्ट दिखाता है.
ServerTemplateData यह डेटा को रिमोट कॉन्फ़िगरेशन वाले सर्वर टेंप्लेट में दिखाता है.
वैल्यू यह पैरामीटर वैल्यू को मेटाडेटा और टाइप-सेफ़ गेटर के साथ रैप करता है.टाइप-सेफ़ गैटर, ऐप्लिकेशन लॉजिक को पैरामीटर के नाम और टाइप में रिमोट बदलावों से इंसुलेट करते हैं.
वर्शन रिमोट कॉन्फ़िगरेशन टेंप्लेट का वर्शन दिखाने वाला इंटरफ़ेस. वर्शन की जानकारी को छोड़कर, सिर्फ़ आउटपुट के लिए. इसमें रिमोट कॉन्फ़िगरेशन टेंप्लेट के खास वर्शन का मेटाडेटा होता है. किसी खास रिमोट कॉन्फ़िगरेशन टेंप्लेट के पब्लिश होने पर सभी फ़ील्ड सेट हो जाते हैं. वर्शन के ब्यौरे वाले फ़ील्ड को publishTemplate कॉल में दिया जा सकता है.

उपनामों का प्रकार

उपनाम टाइप करें ब्यौरा
DefaultConfig इन-ऐप्लिकेशन डिफ़ॉल्ट पैरामीटर वैल्यू के फ़ॉर्मैट के बारे में बताता है.
आकलन का कॉन्टेक्स्ट यह टेंप्लेट के इवैलुएशन के इनपुट सिग्नल दिखाता है.
ParameterValueType रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू के डेटा टाइप को दिखाने वाला टाइप. जानकारी नहीं होने पर, डिफ़ॉल्ट तौर पर STRING पर सेट होती है.
रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू दिखाने वाला टाइप. RemoteConfigParameterValue, ExplicitParameterValue या InAppDefaultValue हो सकता है.
ServerTemplateDataType यह उस रिमोट कॉन्फ़िगरेशन सर्वर टेंप्लेट के टाइप को दिखाता है जिसे ServerTemplate पर सेट किया जा सकता है. यह ServerTemplateData ऑब्जेक्ट या टेंप्लेट JSON स्ट्रिंग हो सकता है.
टैग का रंग डिसप्ले के लिए शर्तों से जुड़े रंग.
वैल्यूसोर्स यह किसी वैल्यू का सोर्स दिखाता है.
  • "स्टैटिक" से पता चलता है कि वैल्यू किसी स्टैटिक कॉन्सटेंट से तय की गई थी.
  • "डिफ़ॉल्ट" इससे पता चलता है कि वैल्यू, डिफ़ॉल्ट कॉन्फ़िगरेशन के ज़रिए तय की गई थी.
  • "रिमोट" यह बताता है कि वैल्यू, टेंप्लेट का आकलन करके बनाए गए कॉन्फ़िगरेशन से तय की गई है.

get RemoteConfig(ऐप्लिकेशन)

यह विकल्प डिफ़ॉल्ट ऐप्लिकेशन या किसी ऐप्लिकेशन के लिए, RemoteConfig सेवा उपलब्ध कराता है.

डिफ़ॉल्ट ऐप्लिकेशन की RemoteConfig सेवा को ऐक्सेस करने के लिए, getRemoteConfig() को बिना किसी आर्ग्युमेंट के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी RemoteConfig सेवा को ऐक्सेस करने के लिए, getRemoteConfig(app) को कॉल किया जा सकता है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
ऐप्लिकेशन ऐप्लिकेशन वैकल्पिक ऐप्लिकेशन जिसके लिए RemoteConfig सेवा देनी है. अगर इस नीति को उपलब्ध नहीं कराया जाता है, तो RemoteConfig की डिफ़ॉल्ट सेवा का इस्तेमाल किया जाता है.

लौटाए जाने वाले प्रॉडक्ट:

रिमोट कॉन्फ़िगरेशन

अगर कोई ऐप्लिकेशन नहीं दिया गया है, तो RemoteConfig की डिफ़ॉल्ट सेवा या दिए गए ऐप्लिकेशन से जुड़ी RemoteConfig सेवा.

उदाहरण 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

उदाहरण 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

डिफ़ॉल्ट कॉन्फ़िगरेशन

इन-ऐप्लिकेशन डिफ़ॉल्ट पैरामीटर वैल्यू के फ़ॉर्मैट के बारे में बताता है.

हस्ताक्षर:

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

आकलन का कॉन्टेक्स्ट

यह टेंप्लेट के इवैलुएशन के इनपुट सिग्नल दिखाता है.

हस्ताक्षर:

export type EvaluationContext = {
    randomizationId?: string;
};

ParameterValueType

रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू के डेटा टाइप को दिखाने वाला टाइप. जानकारी नहीं होने पर, डिफ़ॉल्ट तौर पर STRING पर सेट होती है.

हस्ताक्षर:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू

रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू दिखाने वाला टाइप. RemoteConfigParameterValue, ExplicitParameterValue या InAppDefaultValue हो सकता है.

हस्ताक्षर:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

सर्वर टेंप्लेट डेटा टाइप

यह उस रिमोट कॉन्फ़िगरेशन सर्वर टेंप्लेट के टाइप को दिखाता है जिसे ServerTemplate पर सेट किया जा सकता है. यह ServerTemplateData ऑब्जेक्ट या टेंप्लेट JSON स्ट्रिंग हो सकता है.

हस्ताक्षर:

export type ServerTemplateDataType = ServerTemplateData | string;

टैग का रंग

डिसप्ले के लिए शर्तों से जुड़े रंग.

हस्ताक्षर:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

मान का स्रोत

यह किसी वैल्यू का सोर्स दिखाता है.

  • "स्टैटिक" से पता चलता है कि वैल्यू किसी स्टैटिक कॉन्सटेंट से तय की गई थी.
  • "डिफ़ॉल्ट" इससे पता चलता है कि वैल्यू, डिफ़ॉल्ट कॉन्फ़िगरेशन के ज़रिए तय की गई थी.
  • "रिमोट" यह बताता है कि वैल्यू, टेंप्लेट का आकलन करके बनाए गए कॉन्फ़िगरेशन से तय की गई है.

हस्ताक्षर:

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

PercentCondition ऑपरेटर

प्रतिशत की शर्तों के लिए इस्तेमाल किए जा सकने वाले ऑपरेटर के बारे में बताता है.

हस्ताक्षर:

export declare enum PercentConditionOperator 

इन्यूमरेशन सदस्य

सदस्य मान ब्यौरा
BETWEEN "BETWEEN" निचली सीमा और ऊपरी सीमा से तय किए गए किसी इंटरवल में टारगेट पर्सेंटाइल. निचली सीमा एक खास (खुली) सीमा है और माइक्रो_percent_range_upper_bound, इनक्लूसिव (बंद) की सीमा है. इस ऑपरेटर का इस्तेमाल करने वाली शर्त में माइक्रोPercentRange तय करना ज़रूरी है.
बहुत ज़्यादा "GREATER_THAN" टारगेट पर्सेंटाइल, टारगेट प्रतिशत से ज़्यादा हैं. इस ऑपरेटर का इस्तेमाल करने वाली शर्त में माइक्रोPercent शामिल होना चाहिए.
कम_या_EQUAL "LESS_OR_EQUAL" टारगेट पर्सेंटाइल, टारगेट प्रतिशत से कम या उसके बराबर है. इस ऑपरेटर का इस्तेमाल करने वाली शर्त में माइक्रोPercent शामिल होना चाहिए.
कोई जानकारी नहीं है "UNKNOWN" कैचऑल गड़बड़ी से जुड़ा केस.