機能
関数 | 説明 |
---|---|
ユーザー(ユーザーオプション) | Firebase Auth ユーザー イベントに関連するイベントを処理します。 |
userRecordConstructor(wireData) | ネットワーク経由で送信されたデータからUserRecord クラスを作成するヘルパー関数。 |
クラス
クラス | 説明 |
---|---|
HTTPSエラー | 関数を呼び出したクライアントにエラーを送信するためにハンドラーからスローされる明示的なエラー。 |
ユーザービルダー | Firebase Auth ユーザー ライフサイクル イベントの関数を作成するために使用されるビルダー。 |
ユーザーレコードメタデータ | UserRecord オブジェクトにユーザー メタデータを作成するヘルパー クラス。 |
インターフェース
インターフェース | 説明 |
---|---|
ユーザーオプション | 認証ブロック機能のオプション。 |
タイプエイリアス
タイプエイリアス | 説明 |
---|---|
ユーザー情報 | UserRecord の一部であるUserInfo 。 |
ユーザーレコード | Cloud Functions に渡されるUserRecord 、Firebase Admin SDK によって返されるUserRecordと同じです。 |
auth.user()
Firebase Auth ユーザー イベントに関連するイベントを処理します。
サイン:
export declare function user(userOptions?: UserOptions): UserBuilder;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ユーザーオプション | ユーザーオプション | リソースレベルのオプション |
戻り値:
UserBuilder - Firebase Auth ユーザー ライフサイクル イベントの関数を作成するために使用されるビルダー
auth.userRecordConstructor()
ネットワーク経由で送信されたデータからUserRecord
クラスを作成するヘルパー関数。
サイン:
export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ワイヤーデータ | レコード<文字列、不明> | ネットワーク経由で送信されるデータ |
戻り値:
正しい toJSON 関数を備えたUserRecord
のインスタンス
認証ユーザー情報
UserRecord
の一部であるUserInfo
。
サイン:
export type UserInfo = auth.UserInfo;
auth.UserRecord
Cloud Functions に渡されるUserRecord
、Firebase Admin SDK によって返されるUserRecordと同じです。
サイン:
export type UserRecord = auth.UserRecord;