ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
beforeOperation (eventType, optsOrHandler, ตัวจัดการ) | |
beforeUserCreated (ตัวจัดการ) | จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่จะสร้างผู้ใช้ |
beforeUserCreated (ตัวเลือก ตัวจัดการ) | จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่จะสร้างผู้ใช้ |
beforeUserSignedIn (ตัวจัดการ) | จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่ผู้ใช้จะลงชื่อเข้าใช้ |
beforeUserSignedIn (ตัวเลือก ตัวจัดการ) | จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่ผู้ใช้จะลงชื่อเข้าใช้ |
getOpts (ตัวเลือกการปิดกั้น) |
ชั้นเรียน
ระดับ | คำอธิบาย |
---|---|
HttpsError | ข้อผิดพลาดที่ชัดเจนที่สามารถส่งจากตัวจัดการเพื่อส่งข้อผิดพลาดไปยังไคลเอนต์ที่เรียกว่าฟังก์ชัน |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
AuthBlockingEvent | กำหนดเหตุการณ์การตรวจสอบสิทธิ์สำหรับเหตุการณ์การบล็อกรุ่นที่ 2 |
บันทึกผู้ใช้รับรองความถูกต้อง | UserRecord ส่งผ่านไปยังฟังก์ชันการบล็อกการตรวจสอบสิทธิ์จากแพลตฟอร์มข้อมูลประจำตัว |
ตัวเลือกการปิดกั้น | ตัวเลือกฟังก์ชันทั้งหมด รวมถึง idToken, accessToken และ RefreshToken |
ตัวตน.beforeOperation()
ลายเซ็น:
export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>), handler: (event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ประเภทเหตุการณ์ | AuthBlockingEventType | |
optsOrHandler | การปิดกั้นตัวเลือก | ((เหตุการณ์: AuthBlockingEvent ) => BeforeCreateResponse | BeforeSignInResponse | เป็นโมฆะ | สัญญา <BeforeCreateResponse> | สัญญา<BeforeSignInResponse> | สัญญา<โมฆะ>) | |
ตัวจัดการ | (เหตุการณ์: AuthBlockingEvent ) => BeforeCreateResponse | BeforeSignInResponse | เป็นโมฆะ | สัญญา <BeforeCreateResponse> | สัญญา<BeforeSignInResponse> | สัญญา<โมฆะ> |
ผลตอบแทน:
การปิดกั้นฟังก์ชั่น
ตัวตน.beforeUserCreated()
จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่จะสร้างผู้ใช้
ลายเซ็น:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวจัดการ | (เหตุการณ์: AuthBlockingEvent ) => BeforeCreateResponse | สัญญา <BeforeCreateResponse> | เป็นโมฆะ | สัญญา<โมฆะ> | ตัวจัดการเหตุการณ์ที่รันทุกครั้งก่อนที่จะสร้างผู้ใช้ |
ผลตอบแทน:
การปิดกั้นฟังก์ชั่น
ตัวตน.beforeUserCreated()
จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่จะสร้างผู้ใช้
ลายเซ็น:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
เลือก | ตัวเลือกการปิดกั้น | วัตถุที่มีตัวเลือกฟังก์ชั่น |
ตัวจัดการ | (เหตุการณ์: AuthBlockingEvent ) => BeforeCreateResponse | สัญญา <BeforeCreateResponse> | เป็นโมฆะ | สัญญา<โมฆะ> | ตัวจัดการเหตุการณ์ที่รันทุกครั้งก่อนที่จะสร้างผู้ใช้ |
ผลตอบแทน:
การปิดกั้นฟังก์ชั่น
ตัวตน.beforeUserSignedIn()
จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่ผู้ใช้จะลงชื่อเข้าใช้
ลายเซ็น:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวจัดการ | (เหตุการณ์: AuthBlockingEvent ) => BeforeSignInResponse | สัญญา<BeforeSignInResponse> | เป็นโมฆะ | สัญญา<โมฆะ> | ตัวจัดการเหตุการณ์ซึ่งทำงานทุกครั้งก่อนที่ผู้ใช้จะลงชื่อเข้าใช้ |
ผลตอบแทน:
การปิดกั้นฟังก์ชั่น
ตัวตน.beforeUserSignedIn()
จัดการเหตุการณ์ที่ถูกทริกเกอร์ก่อนที่ผู้ใช้จะลงชื่อเข้าใช้
ลายเซ็น:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
เลือก | ตัวเลือกการปิดกั้น | วัตถุที่มีตัวเลือกฟังก์ชัน |
ตัวจัดการ | (เหตุการณ์: AuthBlockingEvent ) => BeforeSignInResponse | สัญญา<BeforeSignInResponse> | เป็นโมฆะ | สัญญา<โมฆะ> | ตัวจัดการเหตุการณ์ซึ่งทำงานทุกครั้งก่อนที่ผู้ใช้จะลงชื่อเข้าใช้ |
ผลตอบแทน:
การปิดกั้นฟังก์ชั่น
เอกลักษณ์.getOpts()
ลายเซ็น:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
การปิดกั้นตัวเลือก | ตัวเลือกการปิดกั้น |
ผลตอบแทน:
ตัวเลือกภายใน