อินเทอร์เฟซบริการ RemoteConfig
ของ Firebase
ลายเซ็น:
export declare class RemoteConfig
พร็อพเพอร์ตี้
พร็อพเพอร์ตี้ | คีย์ตัวปรับแต่ง | ประเภท | คำอธิบาย |
---|---|---|---|
แอป | แอป |
เมธอด
วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
---|---|---|
createTemplateFromJSON(json) | สร้างและแสดงผลเทมเพลตการกำหนดค่าระยะไกลใหม่จากสตริง JSON | |
getServerTemplate(ตัวเลือก) | จำลอง ServerTemplate จากนั้นดึงข้อมูลและแคชเทมเพลตเวอร์ชันล่าสุดของโปรเจ็กต์ | |
getTemplate() | รับ RemoteConfigTemplate เวอร์ชันปัจจุบันที่ใช้งานอยู่ของโปรเจ็กต์ | |
getTemplateAtVersion(versionNumber) | รับ RemoteConfigTemplate เวอร์ชันที่ขอของโปรเจ็กต์ | |
initServerTemplate(ตัวเลือก) | สร้างอินสแตนซ์ ServerTemplate พร้อมกัน | |
listVersions(ตัวเลือก) | รับรายการเวอร์ชันเทมเพลตการกำหนดค่าระยะไกลที่เผยแพร่แล้ว โดยจัดเรียงตามลำดับเวลาจากใหม่ไปหาเก่า โดยระบบจะจัดเก็บเฉพาะ 300 เวอร์ชันล่าสุดเท่านั้น ระบบจะลบทุกเวอร์ชันที่สอดคล้องกับเทมเพลตการกำหนดค่าระยะไกลที่ไม่มีการใช้งาน (เช่น ทุกเวอร์ชันยกเว้นเทมเพลตที่ไคลเอ็นต์ดึงข้อมูล) ออกหากมีอายุเกิน 90 วัน | |
publishTemplate(เทมเพลต ตัวเลือก) | เผยแพร่เทมเพลตการกำหนดค่าระยะไกล | |
rollback(versionNumber) | ย้อนกลับเทมเพลตการกำหนดค่าระยะไกลที่เผยแพร่แล้วของโปรเจ็กต์ไปเป็นเวอร์ชันที่ระบุ การย้อนกลับเทียบเท่ากับการรับเทมเพลตการกำหนดค่าระยะไกลที่เผยแพร่ก่อนหน้านี้ แล้วเผยแพร่อีกครั้งโดยใช้การบังคับอัปเดต | |
verificationTemplate(template) | ตรวจสอบ RemoteConfigTemplate |
RemoteConfig.app
ลายเซ็น:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
สร้างและแสดงผลเทมเพลตการกำหนดค่าระยะไกลใหม่จากสตริง JSON
ลายเซ็น:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
JSON | string | สตริง JSON สำหรับป้อนข้อมูลเทมเพลตการกำหนดค่าระยะไกล |
การคืนสินค้า:
อินสแตนซ์เทมเพลตใหม่
RemoteConfig.getServerTemplate()
จำลอง ServerTemplate จากนั้นดึงข้อมูลและแคชเทมเพลตเวอร์ชันล่าสุดของโปรเจ็กต์
ลายเซ็น:
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | GetServerTemplateOptions |
การคืนสินค้า:
สัญญา<ServerTemplate>
RemoteConfig.getTemplate()
รับ RemoteConfigTemplate เวอร์ชันปัจจุบันที่ใช้งานอยู่ของโปรเจ็กต์
ลายเซ็น:
getTemplate(): Promise<RemoteConfigTemplate>;
การคืนสินค้า:
สัญญา<RemoteConfigTemplate>
คำสัญญาที่เติมเต็มด้วยRemoteConfigTemplate
RemoteConfig.getTemplateAtVersion()
รับ RemoteConfigTemplate เวอร์ชันที่ขอของโปรเจ็กต์
ลายเซ็น:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
หมายเลขเวอร์ชัน | ตัวเลข | สตริง | หมายเลขเวอร์ชันของเทมเพลตการกำหนดค่าระยะไกลที่ต้องการค้นหา |
การคืนสินค้า:
สัญญา<RemoteConfigTemplate>
คำสัญญาที่เติมเต็มด้วยRemoteConfigTemplate
RemoteConfig.initServerTemplate()
สร้างอินสแตนซ์ ServerTemplate พร้อมกัน
ลายเซ็น:
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | InitServerTemplateOptions |
การคืนสินค้า:
RemoteConfig.listVersions()
รับรายการเวอร์ชันเทมเพลตการกำหนดค่าระยะไกลที่เผยแพร่แล้ว โดยจัดเรียงตามลำดับเวลาจากใหม่ไปหาเก่า โดยระบบจะจัดเก็บเฉพาะ 300 เวอร์ชันล่าสุดเท่านั้น ระบบจะลบทุกเวอร์ชันที่สอดคล้องกับเทมเพลตการกำหนดค่าระยะไกลที่ไม่มีการใช้งาน (เช่น ทุกเวอร์ชันยกเว้นเทมเพลตที่ไคลเอ็นต์ดึงข้อมูล) ออกหากมีอายุเกิน 90 วัน
ลายเซ็น:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ListVersionsOptions | ออบเจ็กต์ตัวเลือกที่ไม่บังคับสำหรับการรับรายการเวอร์ชัน |
การคืนสินค้า:
คำมั่นสัญญา<ListVersions Results>
คำสัญญาที่เติมเต็มด้วยListVersionsResult
RemoteConfig.publishTemplate()
เผยแพร่เทมเพลตการกำหนดค่าระยะไกล
ลายเซ็น:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
เทมเพลต | RemoteConfigTemplate | เทมเพลตการกำหนดค่าระยะไกลที่จะเผยแพร่ |
ตัวเลือก | { บังคับ: บูลีน; } | ออบเจ็กต์ตัวเลือกที่ไม่บังคับเมื่อเผยแพร่เทมเพลตการกำหนดค่าระยะไกล: - force : การตั้งค่านี้เป็น true จะบังคับให้อัปเดตเทมเพลตการกำหนดค่าระยะไกลและหลีกเลี่ยง ETag ไม่แนะนำให้ใช้แนวทางนี้เนื่องจากมีความเสี่ยงที่จะทำให้การอัปเดตเทมเพลตการกำหนดค่าระยะไกลสูญหายไปในกรณีที่มีไคลเอ็นต์หลายคนอัปเดตเทมเพลตการกำหนดค่าระยะไกล โปรดดูการใช้ ETag และการอัปเดตที่บังคับ |
การคืนสินค้า:
สัญญา<RemoteConfigTemplate>
คำมั่นสัญญาที่เติมเต็มด้วยRemoteConfigTemplate
ที่เผยแพร่
RemoteConfig.rollback()
ย้อนกลับเทมเพลตการกำหนดค่าระยะไกลที่เผยแพร่แล้วของโปรเจ็กต์ไปเป็นเวอร์ชันที่ระบุ การย้อนกลับเทียบเท่ากับการรับเทมเพลตการกำหนดค่าระยะไกลที่เผยแพร่ก่อนหน้านี้ แล้วเผยแพร่อีกครั้งโดยใช้การบังคับอัปเดต
ลายเซ็น:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
หมายเลขเวอร์ชัน | ตัวเลข | สตริง | หมายเลขเวอร์ชันของเทมเพลตการกำหนดค่าระยะไกลที่จะย้อนกลับ หมายเลขเวอร์ชันที่ระบุต้องต่ำกว่าหมายเลขเวอร์ชันปัจจุบัน และไม่ถูกลบเนื่องจากไม่มีอัปเดต โดยระบบจะจัดเก็บเฉพาะ 300 เวอร์ชันล่าสุดเท่านั้น เวอร์ชันทั้งหมดที่สอดคล้องกับเทมเพลตการกำหนดค่าระยะไกลที่ไม่มีการใช้งาน (กล่าวคือ ทุกเวอร์ชันยกเว้นเทมเพลตที่ไคลเอ็นต์ดึงข้อมูล) จะถูกลบไปด้วยหากมีมีอายุมากกว่า 90 วัน |
การคืนสินค้า:
สัญญา<RemoteConfigTemplate>
คำมั่นสัญญาที่เติมเต็มด้วยRemoteConfigTemplate
ที่เผยแพร่
RemoteConfig.motionTemplate()
ตรวจสอบ RemoteConfigTemplate
ลายเซ็น:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
เทมเพลต | RemoteConfigTemplate | เทมเพลตการกำหนดค่าระยะไกลที่จะตรวจสอบ |
การคืนสินค้า:
สัญญา<RemoteConfigTemplate>
คำมั่นสัญญาที่ตอบสนองด้วยRemoteConfigTemplate
ที่ผ่านการตรวจสอบความถูกต้อง