auth namespace

機能

関数説明
ユーザー(ユーザーオプション) 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;