機能
関数 | 説明 |
---|---|
beforeOperation(eventType, optsOrHandler, ハンドラー) | |
beforeUserCreated(ハンドラー) | ユーザーが作成される前にトリガーされるイベントを処理します。 |
beforeUserCreated(opts, ハンドラー) | ユーザーが作成される前にトリガーされるイベントを処理します。 |
beforeUserSignedIn(ハンドラー) | ユーザーがサインインする前にトリガーされるイベントを処理します。 |
beforeUserSignedIn(opts, ハンドラー) | ユーザーがサインインする前にトリガーされるイベントを処理します。 |
getOpts(blockingOptions) |
クラス
クラス | 説明 |
---|---|
HTTPSエラー | 関数を呼び出したクライアントにエラーを送信するためにハンドラーからスローされる明示的なエラー。 |
インターフェース
インターフェース | 説明 |
---|---|
認証ブロックイベント | 第 2 世代のブロッキング イベントの認証イベントを定義します |
認証ユーザーレコード | ID プラットフォームから認証ブロッキング機能に渡される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 |ボイド | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> |約束<無効>) | |
ハンドラ | (イベント: AuthBlockingEvent ) => BeforeCreateResponse | BeforeSignInResponse |ボイド | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> |約束<無効> |
戻り値:
ブロッキング機能
identity.beforeUserCreated()
ユーザーが作成される前にトリガーされるイベントを処理します。
サイン:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ハンドラ | (イベント: AuthBlockingEvent ) => BeforeCreateResponse | Promise<BeforeCreateResponse> |ボイド |約束<無効> | ユーザーが作成される前に毎回実行されるイベント ハンドラー |
戻り値:
ブロッキング機能
identity.beforeUserCreated()
ユーザーが作成される前にトリガーされるイベントを処理します。
サイン:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
選択します | ブロッキングオプション | 関数オプションを含むオブジェクト |
ハンドラ | (イベント: AuthBlockingEvent ) => BeforeCreateResponse | Promise<BeforeCreateResponse> |ボイド |約束<無効> | ユーザーが作成される前に毎回実行されるイベント ハンドラー |
戻り値:
ブロッキング機能
identity.beforeUserSignedIn()
ユーザーがサインインする前にトリガーされるイベントを処理します。
サイン:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ハンドラ | (イベント: AuthBlockingEvent ) => BeforeSignInResponse | Promise<BeforeSignInResponse> |ボイド |約束<無効> | ユーザーがサインインする前に毎回実行されるイベント ハンドラー |
戻り値:
ブロッキング機能
identity.beforeUserSignedIn()
ユーザーがサインインする前にトリガーされるイベントを処理します。
サイン:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
選択します | ブロッキングオプション | 関数オプションを含むオブジェクト |
ハンドラ | (イベント: AuthBlockingEvent ) => BeforeSignInResponse | Promise<BeforeSignInResponse> |ボイド |約束<無効> | ユーザーがサインインする前に毎回実行されるイベント ハンドラー |
戻り値:
ブロッキング機能
identity.getOpts()
サイン:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ブロックオプション | ブロッキングオプション |
戻り値:
内部オプション