SDK เว็บการกำหนดค่าระยะไกลของ Firebase SDK นี้ไม่ทำงานในสภาพแวดล้อม Node.js
ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
ฟังก์ชั่น(แอพ, ...) | |
getRemoteConfig (แอป) | |
ฟังก์ชั่น (remoteConfig, ... ) | |
เปิดใช้งาน (remoteConfig) | ทำให้การกำหนดค่าที่ดึงข้อมูลล่าสุดพร้อมใช้งานสำหรับผู้ได้รับ |
ให้แน่ใจว่าเริ่มต้น (remoteConfig) | ตรวจสอบให้แน่ใจว่าการกำหนดค่าที่เปิดใช้งานครั้งล่าสุดพร้อมใช้งานสำหรับผู้ได้รับ |
fetchAndActivate (คอนฟิกระยะไกล) | ดำเนินการดึงข้อมูลและเปิดใช้งานการดำเนินการตามความสะดวก |
fetchConfig (คอนฟิกระยะไกล) | ดึงข้อมูลและแคชการกำหนดค่าจากบริการการกำหนดค่าระยะไกล |
รับทั้งหมด (remoteConfig) | รับการกำหนดค่าทั้งหมด |
getBoolean (remoteConfig, คีย์) | รับค่าสำหรับคีย์ที่กำหนดเป็นบูลีน วิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asBoolean() |
getNumber (remoteConfig, คีย์) | รับค่าสำหรับคีย์ที่กำหนดเป็นตัวเลข วิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asNumber() |
getString (remoteConfig, คีย์) | รับค่าสำหรับคีย์ที่กำหนดเป็นสตริง วิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asString() |
getValue (remoteConfig, คีย์) | รับ ค่า สำหรับคีย์ที่กำหนด |
setLogLevel (remoteConfig, logLevel) | กำหนดระดับบันทึกที่จะใช้ |
การทำงาน() | |
รองรับ() | วิธีนี้มีการตรวจสอบที่แตกต่างกันสองแบบ: 1. ตรวจสอบว่ามี IndexedDB อยู่ในสภาพแวดล้อมเบราว์เซอร์หรือไม่ 2. ตรวจสอบว่าบริบทของเบราว์เซอร์ปัจจุบันอนุญาตให้เรียกใช้ IndexedDB open() หรือไม่ |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
RemoteConfig | อินเทอร์เฟซบริการ Firebase Remote Config |
การตั้งค่า RemoteConfig | กำหนดตัวเลือกการกำหนดค่าสำหรับ Remote Config SDK |
ค่า | ล้อมค่าด้วยข้อมูลเมตาและตัวรับประเภทที่ปลอดภัย |
พิมพ์นามแฝง
พิมพ์นามแฝง | คำอธิบาย |
---|---|
ดึงสถานะ | สรุปผลลัพธ์ของความพยายามครั้งล่าสุดในการดึงการกำหนดค่าจากเซิร์ฟเวอร์ Firebase Remote Config
|
ระดับบันทึก | กำหนดระดับของการบันทึกการกำหนดค่าระยะไกล |
แหล่งที่มาของมูลค่า | บ่งชี้แหล่งที่มาของค่า
|
ฟังก์ชั่น(แอพ, ...)
getRemoteConfig (แอป)
ลายเซ็น:
export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอป | แอป Firebase | อินสแตนซ์ FirebaseApp |
ผลตอบแทน:
อินสแตนซ์ RemoteConfig
ฟังก์ชั่น (remoteConfig, ... )
เปิดใช้งาน (remoteConfig)
ทำให้การกำหนดค่าที่ดึงข้อมูลล่าสุดพร้อมใช้งานสำหรับผู้ได้รับ
ลายเซ็น:
export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
ผลตอบแทน:
สัญญา<บูลีน>
Promise
ที่จะแก้ไขเป็นจริงหากการโทรปัจจุบันเปิดใช้งานการกำหนดค่าที่ดึงข้อมูลมา หากการกำหนดค่าที่ดึงข้อมูลมาถูกเปิดใช้งานแล้ว Promise
จะแก้ไขเป็นเท็จ
ให้แน่ใจว่าเริ่มต้น (remoteConfig)
ตรวจสอบให้แน่ใจว่าการกำหนดค่าที่เปิดใช้งานครั้งล่าสุดพร้อมใช้งานสำหรับผู้ได้รับ
ลายเซ็น:
export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
ผลตอบแทน:
สัญญา<โมฆะ>
Promise
ที่จะแก้ไขเมื่อการกำหนดค่าที่เปิดใช้งานครั้งล่าสุดพร้อมใช้งานสำหรับผู้ได้รับ
fetchAndActivate (คอนฟิกระยะไกล)
ดำเนินการดึงข้อมูลและเปิดใช้งานการดำเนินการตามความสะดวก
ลายเซ็น:
export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
ผลตอบแทน:
สัญญา<บูลีน>
Promise
ที่จะแก้ไขเป็นจริงหากการโทรปัจจุบันเปิดใช้งานการกำหนดค่าที่ดึงข้อมูลมา หากการกำหนดค่าที่ดึงข้อมูลมาถูกเปิดใช้งานแล้ว Promise
จะแก้ไขเป็นเท็จ
fetchConfig (คอนฟิกระยะไกล)
ดึงข้อมูลและแคชการกำหนดค่าจากบริการการกำหนดค่าระยะไกล
ลายเซ็น:
export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
ผลตอบแทน:
สัญญา<โมฆะ>
รับทั้งหมด (remoteConfig)
รับการกำหนดค่าทั้งหมด
ลายเซ็น:
export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
ผลตอบแทน:
บันทึก<สตริง ค่า >
การกำหนดค่าทั้งหมด
getBoolean (remoteConfig, คีย์)
รับค่าสำหรับคีย์ที่กำหนดเป็นบูลีน
วิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asBoolean()
ลายเซ็น:
export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
สำคัญ | เชือก | ชื่อของพารามิเตอร์ |
ผลตอบแทน:
บูลีน
ค่าสำหรับคีย์ที่กำหนดเป็นบูลีน
getNumber (remoteConfig, คีย์)
รับค่าสำหรับคีย์ที่กำหนดเป็นตัวเลข
วิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asNumber()
ลายเซ็น:
export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
สำคัญ | เชือก | ชื่อของพารามิเตอร์ |
ผลตอบแทน:
ตัวเลข
ค่าของคีย์ที่กำหนดเป็นตัวเลข
getString (remoteConfig, คีย์)
รับค่าสำหรับคีย์ที่กำหนดเป็นสตริง วิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asString()
ลายเซ็น:
export declare function getString(remoteConfig: RemoteConfig, key: string): string;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
สำคัญ | เชือก | ชื่อของพารามิเตอร์ |
ผลตอบแทน:
เชือก
ค่าสำหรับคีย์ที่กำหนดเป็นสตริง
getValue (remoteConfig, คีย์)
รับ ค่า สำหรับคีย์ที่กำหนด
ลายเซ็น:
export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
สำคัญ | เชือก | ชื่อของพารามิเตอร์ |
ผลตอบแทน:
ค่าสำหรับคีย์ที่กำหนด
setLogLevel (remoteConfig, logLevel)
กำหนดระดับบันทึกที่จะใช้
ลายเซ็น:
export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การกำหนดค่าระยะไกล | RemoteConfig | อินสแตนซ์ RemoteConfig |
ระดับบันทึก | RemoteConfigLogLevel | ระดับบันทึกที่จะตั้งค่า |
ผลตอบแทน:
เป็นโมฆะ
การทำงาน()
รองรับ()
วิธีนี้มีการตรวจสอบที่แตกต่างกันสองแบบ:
- ตรวจสอบว่า IndexedDB มีอยู่ในสภาพแวดล้อมเบราว์เซอร์หรือไม่ 2. ตรวจสอบว่าบริบทของเบราว์เซอร์ปัจจุบันอนุญาตให้เรียกใช้ IndexedDB
open()
หรือไม่
ลายเซ็น:
export declare function isSupported(): Promise<boolean>;
ผลตอบแทน:
สัญญา<บูลีน>
Promise
ที่แก้ไขเป็นจริงหากอินสแตนซ์ RemoteConfig สามารถเริ่มต้นได้ในสภาพแวดล้อมนี้ หรือเป็นเท็จหากไม่สามารถทำได้
ดึงสถานะ
สรุปผลลัพธ์ของความพยายามครั้งล่าสุดในการดึงการกำหนดค่าจากเซิร์ฟเวอร์ Firebase Remote Config
- "no-fetch-yet" บ่งชี้ว่าอินสแตนซ์ [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) ยังไม่ได้พยายามดึงข้อมูลการกำหนดค่า หรือการกำหนดค่าเริ่มต้น SDK ไม่สมบูรณ์
- "success" หมายถึงความพยายามครั้งล่าสุดสำเร็จ
- "ความล้มเหลว" บ่งชี้ถึงความพยายามครั้งล่าสุดที่ล้มเหลว
- "คันเร่ง" บ่งชี้ว่าความพยายามครั้งสุดท้ายถูกจำกัดอัตรา
ลายเซ็น:
export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
ระดับบันทึก
กำหนดระดับของการบันทึกการกำหนดค่าระยะไกล
ลายเซ็น:
export declare type LogLevel = 'debug' | 'error' | 'silent';
แหล่งที่มาของมูลค่า
บ่งชี้แหล่งที่มาของค่า
- "คงที่" บ่งชี้ถึงค่าที่ถูกกำหนดโดยค่าคงที่คงที่
- "ค่าเริ่มต้น" บ่งชี้ว่าค่าถูกกำหนดโดยการกำหนดค่าเริ่มต้น
- "ระยะไกล" บ่งชี้ว่าค่าถูกกำหนดโดยการกำหนดค่าที่ดึงข้อมูลมา
ลายเซ็น:
export declare type ValueSource = 'static' | 'default' | 'remote';