Firebase アプリ
このパッケージは、さまざまな Firebase コンポーネント間の通信を調整します。
機能
関数 | 説明 |
---|---|
関数(アプリ、...) | |
deleteApp(アプリ) | このアプリを使用不能にし、関連するすべてのサービスのリソースを解放します。 |
関数() | |
getApps() | 初期化されたすべてのアプリの (読み取り専用) 配列。 |
初期化App() | FirebaseApp インスタンスを作成して初期化します。 |
関数(ライブラリキーまたは名前, ...) | |
registerVersion(libraryKeyOrName, バージョン, バリアント) | プラットフォームのログ記録のためにライブラリの名前とバージョンを登録します。 |
関数(logCallback, ...) | |
onLog(logCallback, オプション) | すべての Firebase SDK のログ ハンドラーを設定します。 |
関数(ログレベル, ...) | |
setLogLevel(logLevel) | すべての Firebase SDK のログ レベルを設定します。現在のログ レベルより上のすべてのログ タイプがキャプチャされます (つまり、ログ レベルをinfo に設定すると、エラーはログに記録されますが、 debug とverbose ログは記録されません)。 |
関数(名前, ...) | |
getApp(名前) | FirebaseAppインスタンスを取得します。引数なしで呼び出された場合、デフォルトのアプリが返されます。アプリ名を指定すると、その名前に対応するアプリが返されます。取得されるアプリがまだ初期化されていない場合は、例外がスローされます。 |
関数(オプション, ...) | |
InitializeApp(オプション, 名前) | FirebaseAppインスタンスを作成して初期化します。詳細なドキュメントについては、「アプリに Firebase を追加する」と「複数のプロジェクトを初期化する」を参照してください。 |
初期化App(オプション、構成) | FirebaseApp インスタンスを作成して初期化します。 |
インターフェース
インターフェース | 説明 |
---|---|
FirebaseApp | FirebaseAppは、サービスのコレクションの初期化情報を保持します。このコンストラクターを直接呼び出さないでください。代わりに、 initializeApp()を使用してアプリを作成します。 |
FirebaseApp設定 | InitializeApp()に指定される構成オプション |
Firebaseオプション | Firebase 構成オブジェクト。 Firebase サーバー API と正常に通信し、クライアント データを Firebase プロジェクトおよび Firebase アプリケーションに関連付けるためにサービスで必要なパラメータのセットが含まれています。通常、このオブジェクトはプロジェクトのセットアップ時に Firebase コンソールによって設定されます。参照: Firebase config オブジェクトについて学ぶ。 |
変数
変数 | 説明 |
---|---|
SDK_VERSION | 現在の SDK バージョン。 |
関数(アプリ、...)
deleteApp(アプリ)
このアプリを使用不能にし、関連するすべてのサービスのリソースを解放します。
サイン:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | FirebaseApp |
戻り値:
約束<無効>
例
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
関数()
getApps()
初期化されたすべてのアプリの (読み取り専用) 配列。
サイン:
export declare function getApps(): FirebaseApp[];
戻り値:
FirebaseApp []
初期化App()
FirebaseApp インスタンスを作成して初期化します。
サイン:
export declare function initializeApp(): FirebaseApp;
戻り値:
関数(ライブラリキーまたは名前, ...)
registerVersion(libraryKeyOrName, バージョン, バリアント)
プラットフォームのログ記録のためにライブラリの名前とバージョンを登録します。
サイン:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ライブラリキーまたは名前 | 弦 | |
バージョン | 弦 | そのライブラリの現在のバージョン。 |
変異体 | 弦 | バンドルのバリアント (node、rn など)。 |
戻り値:
空所
関数(logCallback, ...)
onLog(logCallback, オプション)
すべての Firebase SDK のログ ハンドラーを設定します。
サイン:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ログコールバック | ログコールバック |ヌル | Firebase SDK がロギング呼び出しを行うたびにユーザー コードを実行するオプションのカスタム ログ ハンドラ。 |
オプション | ログオプション |
戻り値:
空所
関数(ログレベル, ...)
setLogLevel(logLevel)
すべての Firebase SDK のログ レベルを設定します。
現在のログ レベルより上のすべてのログ タイプがキャプチャされます (つまり、ログ レベルをinfo
に設定した場合) 、エラーはログに記録されますが、 debug
とverbose
ログは記録されません)。
サイン:
export declare function setLogLevel(logLevel: LogLevelString): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ログレベル | ログレベル文字列 |
戻り値:
空所
関数(名前, ...)
getApp(名前)
FirebaseAppインスタンスを取得します。
引数なしで呼び出された場合、デフォルトのアプリが返されます。アプリ名を指定すると、その名前に対応するアプリが返されます。
取得されるアプリがまだ初期化されていない場合は、例外がスローされます。
サイン:
export declare function getApp(name?: string): FirebaseApp;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 | 返されるアプリのオプションの名前。名前が指定されていない場合、デフォルトは"[DEFAULT]" です。 |
戻り値:
指定されたアプリ名に対応するアプリ。アプリ名が指定されていない場合は、デフォルトのアプリが返されます。
例1
// Return the default app
const app = getApp();
例 2
// Return a named app
const otherApp = getApp("otherApp");
関数(オプション, ...)
InitializeApp(オプション, 名前)
FirebaseAppインスタンスを作成して初期化します。
詳細なドキュメントについては、「アプリに Firebase を追加する」と「複数のプロジェクトを初期化する」を参照してください。
サイン:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | Firebaseオプション | アプリのサービスを構成するオプション。 |
名前 | 弦 | 初期化するアプリのオプションの名前。名前が指定されていない場合、デフォルトは"[DEFAULT]" です。 |
戻り値:
初期化されたアプリ。
例1
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
例 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
初期化App(オプション、構成)
FirebaseApp インスタンスを作成して初期化します。
サイン:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | Firebaseオプション | アプリのサービスを構成するオプション。 |
構成 | FirebaseApp設定 | FirebaseApp の構成 |
戻り値:
SDK_VERSION
現在の SDK バージョン。
サイン:
SDK_VERSION: string