remote-config package

SDK เว็บการกำหนดค่าระยะไกลของ Firebase SDK นี้ไม่ทำงานในสภาพแวดล้อม Node.js

ฟังก์ชัน

ฟังก์ชัน คำอธิบาย
ฟังก์ชัน(แอป, ...)
getRemoteConfig(แอป)
function(remoteConfig, ...)
activate(remoteConfig) ทำให้การกำหนดค่าที่ดึงข้อมูลล่าสุดพร้อมใช้งานสำหรับ Getters
ensureInitialized(remoteConfig) ตรวจสอบว่าการกำหนดค่าที่เปิดใช้งานล่าสุดพร้อมใช้งานสำหรับ Getters
fetchAndActivate(remoteConfig) ดำเนินการดึงข้อมูลและเปิดใช้งานเพื่อความสะดวก
fetchConfig(remoteConfig) ดึงข้อมูลและแคชการกำหนดค่าจากบริการการกำหนดค่าระยะไกล
getAll(remoteConfig) กำหนดค่าทั้งหมด
getBoolean(remoteConfig, คีย์) รับค่าสำหรับคีย์ที่ระบุเป็นบูลีนวิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asBoolean()
getNumber(remoteConfig, key) รับค่าสำหรับคีย์ที่ระบุเป็นตัวเลขวิธีที่สะดวกสำหรับการเรียก remoteConfig.getValue(key).asNumber()
getString(remoteConfig, คีย์) รับค่าของคีย์ที่ระบุเป็นสตริง ช่องทางที่สะดวกในการโทรหา remoteConfig.getValue(key).asString()
getValue(remoteConfig, key) รับค่าสำหรับคีย์ที่ระบุ
setLogLevel(remoteConfig, logLevel) กำหนดระดับการบันทึกที่จะใช้
function()
isSupported() วิธีนี้มีการตรวจสอบ 2 แบบที่แตกต่างกัน ได้แก่1. ตรวจสอบว่ามี IndexedDB อยู่ในสภาพแวดล้อมเบราว์เซอร์หรือไม่ 2. ตรวจสอบว่าบริบทเบราว์เซอร์ปัจจุบันอนุญาตการเรียก open() IndexedDB หรือไม่

อินเทอร์เฟซ

อินเทอร์เฟซ คำอธิบาย
RemoteConfig อินเทอร์เฟซบริการการกำหนดค่าระยะไกลของ Firebase
RemoteConfigSettings กำหนดตัวเลือกการกำหนดค่าสำหรับ SDK การกำหนดค่าระยะไกล
ค่า รวมค่าด้วยข้อมูลเมตาและ Getter ที่ปลอดภัยประเภท

พิมพ์ชื่อแทน

พิมพ์ชื่อแทน คำอธิบาย
FetchStatus สรุปผลลัพธ์ของการพยายามดึงข้อมูลการกำหนดค่าจากเซิร์ฟเวอร์การกำหนดค่าระยะไกลของ Firebase ครั้งล่าสุด
  • "ยังไม่ดึงข้อมูล" ระบุว่าอินสแตนซ์ RemoteConfig ยังไม่ได้พยายามดึงข้อมูลการกำหนดค่า หรือการเริ่มต้น SDK นั้นไม่สมบูรณ์
  • "ความสำเร็จ" บ่งชี้ถึงการพยายามครั้งสุดท้ายสำเร็จ
  • "ล้มเหลว" ระบุความพยายามครั้งล่าสุดไม่สำเร็จ
  • "ควบคุม" ระบุว่าความพยายามล่าสุดถูกจำกัดอัตรา
LogLevel กำหนดระดับของการบันทึกการกำหนดค่าระยะไกล
ValueSource ระบุแหล่งที่มาของค่า
  • "คงที่" แสดงว่าค่านี้กำหนดโดยค่าคงที่คงที่
  • "ค่าเริ่มต้น" ระบุว่าค่านี้มีการกำหนดโดยการกำหนดค่าเริ่มต้น
  • "รีโมต" ระบุว่าค่านี้มีการกำหนดโดยการกำหนดค่าที่ดึงข้อมูล

ฟังก์ชัน(แอป, ...)

getRemoteConfig(แอป)

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
แอป แอป Firebase อินสแตนซ์ FirebaseApp

การคืนสินค้า:

RemoteConfig

อินสแตนซ์ RemoteConfig

ฟังก์ชัน(remoteConfig, ...)

เปิดใช้งาน(remoteConfig)

ทำให้การกำหนดค่าที่ดึงข้อมูลล่าสุดพร้อมใช้งานสำหรับ Getters

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การกำหนดค่าระยะไกล RemoteConfig อินสแตนซ์ RemoteConfig

การคืนสินค้า:

Promise&lt;boolean&gt;

Promise ซึ่งจะเปลี่ยนเป็น "จริง" หากการเรียกใช้ปัจจุบันเปิดใช้งานการกำหนดค่าที่ดึงข้อมูลไว้ หากเปิดใช้งานการกำหนดค่าที่ดึงข้อมูลไว้แล้ว Promise จะเปลี่ยนเป็น "เท็จ"

ตรวจสอบให้แน่ใจเริ่มต้น(remoteConfig)

ตรวจสอบว่าการกำหนดค่าที่เปิดใช้งานล่าสุดพร้อมใช้งานสำหรับ Getters

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การกำหนดค่าระยะไกล RemoteConfig อินสแตนซ์ RemoteConfig

การคืนสินค้า:

คำมั่นสัญญา<โมฆะ>

Promise ที่จะแก้ไขเมื่อการกำหนดค่าที่เปิดใช้งานล่าสุดพร้อมใช้งานสำหรับ Getters

FetchAndActivate(remoteConfig)

ดำเนินการดึงข้อมูลและเปิดใช้งานเพื่อความสะดวก

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การกำหนดค่าระยะไกล RemoteConfig อินสแตนซ์ RemoteConfig

การคืนสินค้า:

Promise&lt;boolean&gt;

Promise ซึ่งจะเปลี่ยนเป็น "จริง" หากการเรียกใช้ปัจจุบันเปิดใช้งานการกำหนดค่าที่ดึงข้อมูลไว้ หากเปิดใช้งานการกำหนดค่าที่ดึงข้อมูลไว้แล้ว Promise จะเปลี่ยนเป็น "เท็จ"

GooglebotConfig(remoteConfig)

การกำหนดค่าการดึงข้อมูลและแคชจากบริการการกำหนดค่าระยะไกล

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การกำหนดค่าระยะไกล RemoteConfig อินสแตนซ์ RemoteConfig

การคืนสินค้า:

คำมั่นสัญญา<โมฆะ>

getAll(remoteConfig)

กำหนดค่าทั้งหมด

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การกำหนดค่าระยะไกล RemoteConfig อินสแตนซ์ RemoteConfig

การคืนสินค้า:

บันทึก<string, ค่า>

การกำหนดค่าทั้งหมด

getBoolean(remoteConfig, คีย์)

รับค่าของคีย์ที่ระบุเป็นบูลีน

ช่องทางที่สะดวกในการโทรหา remoteConfig.getValue(key).asBoolean()

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การกำหนดค่าระยะไกล RemoteConfig อินสแตนซ์ RemoteConfig
แป้น สตริง ชื่อพารามิเตอร์

การคืนสินค้า:

boolean

ค่าของคีย์ที่ระบุเป็นบูลีน

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 ระดับการบันทึกที่จะตั้งค่า

การคืนสินค้า:

เป็นโมฆะ

ฟังก์ชัน()

issupported()

วิธีนี้มีการตรวจสอบที่แตกต่างกัน 2 แบบ ได้แก่

  1. ตรวจสอบว่ามี IndexedDB อยู่ในสภาพแวดล้อมเบราว์เซอร์หรือไม่ 2. ตรวจสอบว่าบริบทเบราว์เซอร์ปัจจุบันอนุญาตการเรียก open() IndexedDB หรือไม่

ลายเซ็น:

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

การคืนสินค้า:

Promise&lt;boolean&gt;

Promise ที่จะแปลงค่าเป็น "จริง" หากเริ่มต้นอินสแตนซ์ RemoteConfig ในสภาพแวดล้อมนี้ได้ หรือ เท็จ หากเริ่มต้นไม่ได้

สถานะการดึงข้อมูล

สรุปผลลัพธ์ของการพยายามดึงข้อมูลการกำหนดค่าจากเซิร์ฟเวอร์การกำหนดค่าระยะไกลของ Firebase ครั้งล่าสุด

  • "ยังไม่ดึงข้อมูล" บ่งบอกว่าอินสแตนซ์ [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';