פונקציות
פוּנקצִיָה | תיאור |
---|---|
beforeOperation(eventType, optsOrHandler, handler) | |
beforeUserCreated(handler) | מטפל באירוע שהופעל לפני יצירת משתמש. |
beforeUserCreated(opts, handler) | מטפל באירוע שהופעל לפני יצירת משתמש. |
beforeUserSignedIn(handler) | מטפל באירוע שהופעל לפני שמשתמש נכנס. |
beforeUserSignedIn(opts, handler) | מטפל באירוע שהופעל לפני שמשתמש נכנס. |
getOpts(blockingOptions) |
שיעורים
מעמד | תיאור |
---|---|
HttpsError | שגיאה מפורשת שניתן לזרוק ממטפל כדי לשלוח שגיאה ללקוח שקרא לפונקציה. |
ממשקים
מִמְשָׁק | תיאור |
---|---|
AuthBlockingEvent | מגדיר את אירוע האישור עבור אירועי חסימה של דור שני |
AuthUserRecord | UserRecord הועבר לפונקציות חסימת אימות מפלטפורמת הזהות. |
חסימה אפשרויות | כל אפשרויות הפונקציה בתוספת idToken, accessToken ו-refreshToken. |
identity.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> | הבטחה<void>) | |
מטפל | (אירוע: AuthBlockingEvent ) => BeforeCreateResponse | BeforeSignInResponse | בטל | הבטחה<BeforeCreateResponse> | הבטחה<BeforeSignInResponse> | הבטחה<void> |
החזרות:
BlockingFunction
identity.beforeUserCreated()
מטפל באירוע שהופעל לפני יצירת משתמש.
חֲתִימָה:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מטפל | (אירוע: AuthBlockingEvent ) => BeforeCreateResponse | הבטחה<BeforeCreateResponse> | בטל | הבטחה<void> | מטפל באירועים המופעל בכל פעם לפני יצירת משתמש |
החזרות:
BlockingFunction
identity.beforeUserCreated()
מטפל באירוע שהופעל לפני יצירת משתמש.
חֲתִימָה:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
בוחר | חסימה אפשרויות | אובייקט המכיל אפשרויות פונקציה |
מטפל | (אירוע: AuthBlockingEvent ) => BeforeCreateResponse | הבטחה<BeforeCreateResponse> | בטל | הבטחה<void> | מטפל באירועים המופעל בכל פעם לפני יצירת משתמש |
החזרות:
BlockingFunction
identity.beforeUserSignedIn()
מטפל באירוע שהופעל לפני שמשתמש נכנס.
חֲתִימָה:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מטפל | (אירוע: AuthBlockingEvent ) => BeforeSignInResponse | הבטחה<BeforeSignInResponse> | בטל | הבטחה<void> | מטפל באירועים המופעל בכל פעם לפני שמשתמש נכנס |
החזרות:
BlockingFunction
identity.beforeUserSignedIn()
מטפל באירוע שהופעל לפני שמשתמש נכנס.
חֲתִימָה:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
בוחר | חסימה אפשרויות | אובייקט המכיל אפשרויות פונקציה |
מטפל | (אירוע: AuthBlockingEvent ) => BeforeSignInResponse | הבטחה<BeforeSignInResponse> | בטל | הבטחה<void> | מטפל באירועים המופעל בכל פעם לפני שמשתמש נכנס |
החזרות:
BlockingFunction
identity.getOpts()
חֲתִימָה:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
חסימת אפשרויות | חסימה אפשרויות |
החזרות:
אפשרויות פנימיות