remote-config package

फायरबेस रिमोट कॉन्फिग वेब एसडीके। यह SDK Node.js परिवेश में काम नहीं करता है.

कार्य

समारोह विवरण
फ़ंक्शन (ऐप, ...)
getRemoteConfig(ऐप)
फ़ंक्शन (रिमोट कॉन्फिग, ...)
सक्रिय करें (रिमोटकॉन्फिग) अंतिम प्राप्त कॉन्फ़िगरेशन को गेटर्स के लिए उपलब्ध कराता है।
सुनिश्चितप्रारंभिक(रिमोटकॉन्फिग) यह सुनिश्चित करता है कि अंतिम सक्रिय कॉन्फ़िगरेशन गेटर्स के लिए उपलब्ध है।
फ़ेचएंडएक्टिवेट(रिमोटकॉन्फिग) सुविधा के तौर पर लाने और सक्रिय करने का कार्य करता है।
फ़ेच कॉन्फ़िग(रिमोट कॉन्फ़िग) रिमोट कॉन्फ़िगरेशन सेवा से कॉन्फ़िगरेशन प्राप्त करें और कैश करें।
सभी प्राप्त करें(रिमोट कॉन्फिग) सभी कॉन्फ़िगरेशन प्राप्त करता है।
getBoolean(रिमोट कॉन्फिग, कुंजी) बूलियन के रूप में दी गई कुंजी का मान प्राप्त करता है। remoteConfig.getValue(key).asBoolean() कॉल करने की सुविधाजनक विधि।
getNumber(रिमोट कॉन्फिग, कुंजी) किसी संख्या के रूप में दी गई कुंजी का मान प्राप्त करता है। remoteConfig.getValue(key).asNumber() कॉल करने की सुविधाजनक विधि।
getString(रिमोट कॉन्फिग, कुंजी) एक स्ट्रिंग के रूप में दी गई कुंजी का मान प्राप्त करता है। remoteConfig.getValue(key).asString() कॉल करने की सुविधाजनक विधि।
getValue(रिमोट कॉन्फिग, कुंजी) दी गई कुंजी के लिए मान प्राप्त करता है।
सेटलॉगलेवल(रिमोटकॉन्फिग, लॉगलेवल) उपयोग करने के लिए लॉग स्तर को परिभाषित करता है।
समारोह()
समर्थित है() यह विधि दो अलग-अलग जाँचें प्रदान करती है: 1. जांचें कि क्या IndexedDB ब्राउज़र वातावरण में मौजूद है। 2. जांचें कि क्या वर्तमान ब्राउज़र संदर्भ IndexedDB open() कॉल की अनुमति देता है।

इंटरफेस

इंटरफेस विवरण
रिमोट कॉन्फिग फायरबेस रिमोट कॉन्फिग सेवा इंटरफ़ेस।
रिमोटकॉन्फिगसेटिंग्स रिमोट कॉन्फिग एसडीके के लिए कॉन्फ़िगरेशन विकल्पों को परिभाषित करता है।
कीमत मेटाडेटा और टाइप-सुरक्षित गेटर्स के साथ एक मान लपेटता है।

उपनाम टाइप करें

उपनाम टाइप करें विवरण
FetchStatus फ़ायरबेस रिमोट कॉन्फ़िग सर्वर से कॉन्फ़िगरेशन लाने के अंतिम प्रयास के परिणाम का सारांश प्रस्तुत करता है।
  • "नो-फ़ेच-येट" इंगित करता है कि रिमोटकॉन्फिग इंस्टेंस ने अभी तक कॉन्फ़िगरेशन लाने का प्रयास नहीं किया है, या एसडीके आरंभीकरण अधूरा है।
  • "सफलता" इंगित करती है कि अंतिम प्रयास सफल हुआ।
  • "विफलता" अंतिम प्रयास विफल होने का संकेत देती है।
  • "थ्रॉटल" इंगित करता है कि अंतिम प्रयास दर-सीमित था।
छांटने का स्तर रिमोट कॉन्फिग लॉगिंग के स्तर को परिभाषित करता है।
वैल्यूसोर्स किसी मान के स्रोत को इंगित करता है.
  • "स्थैतिक" इंगित करता है कि मान एक स्थिर स्थिरांक द्वारा परिभाषित किया गया था।
  • "डिफ़ॉल्ट" इंगित करता है कि मान डिफ़ॉल्ट कॉन्फ़िगरेशन द्वारा परिभाषित किया गया था।
  • "रिमोट" इंगित करता है कि मान प्राप्त कॉन्फ़िगरेशन द्वारा परिभाषित किया गया था।

फ़ंक्शन (ऐप, ...)

getRemoteConfig(ऐप)

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग फायरबेस ऐप FirebaseApp उदाहरण।

रिटर्न:

रिमोट कॉन्फिग

एक रिमोटकॉन्फिग उदाहरण।

फ़ंक्शन (रिमोट कॉन्फिग, ...)

सक्रिय करें (रिमोटकॉन्फिग)

अंतिम प्राप्त कॉन्फ़िगरेशन को गेटर्स के लिए उपलब्ध कराता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।

रिटर्न:

वादा<बूलियन>

एक Promise जो सत्य हो जाता है यदि वर्तमान कॉल प्राप्त कॉन्फ़िगरेशन को सक्रिय करता है। यदि प्राप्त कॉन्फ़िगरेशन पहले से ही सक्रिय थे, तो Promise गलत हो जाएगा।

सुनिश्चितप्रारंभिक(रिमोटकॉन्फिग)

यह सुनिश्चित करता है कि अंतिम सक्रिय कॉन्फ़िगरेशन गेटर्स के लिए उपलब्ध है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।

रिटर्न:

वादा<शून्य>

एक Promise जो अंतिम सक्रिय कॉन्फिगरेशन प्राप्तकर्ताओं के लिए उपलब्ध होने पर हल हो जाता है।

फ़ेचएंडएक्टिवेट(रिमोटकॉन्फिग)

सुविधा के तौर पर लाने और सक्रिय करने का कार्य करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।

रिटर्न:

वादा<बूलियन>

एक Promise जो सत्य हो जाता है यदि वर्तमान कॉल प्राप्त कॉन्फ़िगरेशन को सक्रिय करता है। यदि प्राप्त कॉन्फ़िगरेशन पहले से ही सक्रिय थे, तो Promise गलत हो जाएगा।

फ़ेच कॉन्फ़िग(रिमोट कॉन्फ़िग)

रिमोट कॉन्फ़िगरेशन सेवा से कॉन्फ़िगरेशन प्राप्त करें और कैश करें।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।

रिटर्न:

वादा<शून्य>

सभी प्राप्त करें(रिमोट कॉन्फिग)

सभी कॉन्फ़िगरेशन प्राप्त करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।

रिटर्न:

रिकॉर्ड <स्ट्रिंग, मान >

सभी कॉन्फ़िग.

getBoolean(रिमोट कॉन्फिग, कुंजी)

बूलियन के रूप में दी गई कुंजी का मान प्राप्त करता है।

remoteConfig.getValue(key).asBoolean() कॉल करने की सुविधाजनक विधि।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।
चाबी डोरी पैरामीटर का नाम.

रिटर्न:

बूलियन

बूलियन के रूप में दी गई कुंजी का मान.

getNumber(रिमोट कॉन्फिग, कुंजी)

किसी संख्या के रूप में दी गई कुंजी का मान प्राप्त करता है।

remoteConfig.getValue(key).asNumber() कॉल करने की सुविधाजनक विधि।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।
चाबी डोरी पैरामीटर का नाम.

रिटर्न:

संख्या

किसी संख्या के रूप में दी गई कुंजी का मान.

getString(रिमोट कॉन्फिग, कुंजी)

एक स्ट्रिंग के रूप में दी गई कुंजी का मान प्राप्त करता है। remoteConfig.getValue(key).asString() कॉल करने की सुविधाजनक विधि।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।
चाबी डोरी पैरामीटर का नाम.

रिटर्न:

डोरी

एक स्ट्रिंग के रूप में दी गई कुंजी का मान.

getValue(रिमोट कॉन्फिग, कुंजी)

दी गई कुंजी के लिए मान प्राप्त करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।
चाबी डोरी पैरामीटर का नाम.

रिटर्न:

कीमत

दी गई कुंजी का मान.

सेटलॉगलेवल(रिमोटकॉन्फिग, लॉगलेवल)

उपयोग करने के लिए लॉग स्तर को परिभाषित करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
रिमोट कॉन्फिग रिमोट कॉन्फिग रिमोटकॉन्फिग उदाहरण।
छांटने का स्तर रिमोटकॉन्फिगलॉगलेवल सेट करने के लिए लॉग स्तर.

रिटर्न:

खालीपन

समारोह()

समर्थित है()

यह विधि दो अलग-अलग जाँचें प्रदान करती है:

  1. जांचें कि क्या IndexedDB ब्राउज़र वातावरण में मौजूद है। 2. जांचें कि क्या वर्तमान ब्राउज़र संदर्भ IndexedDB open() कॉल की अनुमति देता है।

हस्ताक्षर:

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

रिटर्न:

वादा<बूलियन>

एक Promise जो इस वातावरण में रिमोट कॉन्फिग इंस्टेंस को प्रारंभ किया जा सकता है तो सही हो जाता है, या नहीं हो सकता है तो गलत हो जाता है।

FetchStatus

फ़ायरबेस रिमोट कॉन्फ़िग सर्वर से कॉन्फ़िगरेशन लाने के अंतिम प्रयास के परिणाम का सारांश प्रस्तुत करता है।

  • "no-fetch-yet" इंगित करता है कि [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) इंस्टेंस ने अभी तक कॉन्फ़िगरेशन लाने का प्रयास नहीं किया है, या SDK आरंभीकरण अधूरा है।
  • "सफलता" इंगित करती है कि अंतिम प्रयास सफल हुआ।
  • "विफलता" अंतिम प्रयास विफल होने का संकेत देती है।
  • "थ्रॉटल" इंगित करता है कि अंतिम प्रयास दर-सीमित था।

हस्ताक्षर:

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

छांटने का स्तर

रिमोट कॉन्फिग लॉगिंग के स्तर को परिभाषित करता है।

हस्ताक्षर:

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

वैल्यूसोर्स

किसी मान के स्रोत को इंगित करता है.

  • "स्थैतिक" इंगित करता है कि मान एक स्थिर स्थिरांक द्वारा परिभाषित किया गया था।
  • "डिफ़ॉल्ट" इंगित करता है कि मान डिफ़ॉल्ट कॉन्फ़िगरेशन द्वारा परिभाषित किया गया था।
  • "रिमोट" इंगित करता है कि मान प्राप्त कॉन्फ़िगरेशन द्वारा परिभाषित किया गया था।

हस्ताक्षर:

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