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