installations package

SDK เว็บการติดตั้ง Firebase SDK นี้ไม่ทำงานในสภาพแวดล้อม Node.js

ฟังก์ชั่น

การทำงาน คำอธิบาย
ฟังก์ชั่น(แอพ, ...)
รับการติดตั้ง (แอป) ส่งคืนอินสแตนซ์ของ การติดตั้ง ที่เกี่ยวข้องกับอินสแตนซ์ FirebaseApp ที่กำหนด
ฟังก์ชั่น(การติดตั้ง, ...)
ลบการติดตั้ง(การติดตั้ง) ลบการติดตั้ง Firebase และข้อมูลที่เกี่ยวข้องทั้งหมด
getId (การติดตั้ง) สร้างการติดตั้ง Firebase หากไม่มีสำหรับแอปและส่งกลับรหัสการติดตั้ง
getToken (การติดตั้ง, forceRefresh) ส่งคืนโทเค็นการตรวจสอบสิทธิ์การติดตั้ง Firebase เพื่อระบุการติดตั้ง Firebase ปัจจุบัน
onIdChange (การติดตั้ง, การโทรกลับ) ตั้งค่าการโทรกลับใหม่ซึ่งจะถูกเรียกเมื่อ ID การติดตั้งเปลี่ยนแปลง ส่งคืนฟังก์ชันยกเลิกการสมัครที่จะลบการโทรกลับเมื่อถูกเรียก

อินเทอร์เฟซ

อินเตอร์เฟซ คำอธิบาย
การติดตั้ง อินเทอร์เฟซสาธารณะของ Firebase Installations SDK

พิมพ์นามแฝง

พิมพ์นามแฝง คำอธิบาย
IdChangeCallbackFn ฟังก์ชันการเรียกกลับที่ผู้ใช้กำหนดซึ่งจะถูกเรียกเมื่อ ID การติดตั้งเปลี่ยนแปลง
IdChangeUnsubscribeFn ยกเลิกการสมัครฟังก์ชั่นการโทรกลับที่เพิ่มไว้ก่อนหน้านี้ผ่าน IdChangeCallbackFn .

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

รับการติดตั้ง (แอป)

ส่งคืนอินสแตนซ์ของ การติดตั้ง ที่เกี่ยวข้องกับอินสแตนซ์ FirebaseApp ที่กำหนด

ลายเซ็น:

export declare function getInstallations(app?: FirebaseApp): Installations;

พารามิเตอร์

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

ผลตอบแทน:

การติดตั้ง

ฟังก์ชั่น(การติดตั้ง, ...)

ลบการติดตั้ง(การติดตั้ง)

ลบการติดตั้ง Firebase และข้อมูลที่เกี่ยวข้องทั้งหมด

ลายเซ็น:

export declare function deleteInstallations(installations: Installations): Promise<void>;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
การติดตั้ง การติดตั้ง Installations

ผลตอบแทน:

สัญญา<โมฆะ>

getId (การติดตั้ง)

สร้างการติดตั้ง Firebase หากไม่มีสำหรับแอปและส่งกลับรหัสการติดตั้ง

ลายเซ็น:

export declare function getId(installations: Installations): Promise<string>;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
การติดตั้ง การติดตั้ง Installations

ผลตอบแทน:

สัญญา<สตริง>

getToken (การติดตั้ง, forceRefresh)

ส่งคืนโทเค็นการตรวจสอบสิทธิ์การติดตั้ง Firebase เพื่อระบุการติดตั้ง Firebase ปัจจุบัน

ลายเซ็น:

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
การติดตั้ง การติดตั้ง Installations
บังคับรีเฟรช บูลีน บังคับให้รีเฟรชโดยไม่คำนึงถึงการหมดอายุของโทเค็น

ผลตอบแทน:

สัญญา<สตริง>

onIdChange (การติดตั้ง, การโทรกลับ)

ตั้งค่าการโทรกลับใหม่ซึ่งจะถูกเรียกเมื่อ ID การติดตั้งเปลี่ยนแปลง ส่งคืนฟังก์ชันยกเลิกการสมัครที่จะลบการโทรกลับเมื่อถูกเรียก

ลายเซ็น:

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
การติดตั้ง การติดตั้ง Installations
โทรกลับ IdChangeCallbackFn ฟังก์ชันโทรกลับที่ถูกเรียกใช้เมื่อ FID เปลี่ยนแปลง

ผลตอบแทน:

IdChangeUnsubscribeFn

ฟังก์ชั่นที่สามารถเรียกยกเลิกการสมัครได้

IdChangeCallbackFn

ฟังก์ชันการเรียกกลับที่ผู้ใช้กำหนดซึ่งจะถูกเรียกเมื่อ ID การติดตั้งเปลี่ยนแปลง

ลายเซ็น:

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdChangeUnsubscribeFn

ยกเลิกการสมัครฟังก์ชั่นการโทรกลับที่เพิ่มไว้ก่อนหน้านี้ผ่าน IdChangeCallbackFn .

ลายเซ็น:

export declare type IdChangeUnsubscribeFn = () => void;