Firebase アプリ
このパッケージは、さまざまな Firebase コンポーネント間の通信を調整
関数
関数 | 説明 |
---|---|
function(app, ...) を使用します。 | |
deleteApp(アプリ) | このアプリを使用できなくし、関連するすべてのサービスのリソースを解放します。 |
関数 | |
getApps() | 初期化されたすべてのアプリの(読み取り専用)配列。 |
initializeApp() | FirebaseApp インスタンスを作成して初期化します。 |
function(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, version, variant) | プラットフォーム ロギングの目的でライブラリの名前とバージョンを登録します。 |
function(logCallback, ...) を使用します。 | |
onLog(logCallback, options) | すべての Firebase SDK のログハンドラを設定します。 |
function(logLevel, ...) | |
setLogLevel(logLevel) | すべての Firebase SDK のログレベルを設定します。現在のログレベルを超えるすべてのログタイプがキャプチャされます(たとえば、ログレベルを info に設定すると、エラーは記録されますが、debug ログと verbose ログはキャプチャされません)。 |
function(name, ...) を使用します。 | |
getApp(name) | FirebaseApp インスタンスを取得します。引数なしで呼び出すと、デフォルトのアプリが返されます。アプリ名を指定すると、その名前に対応するアプリが返されます。取得対象のアプリがまだ初期化されていない場合は、例外がスローされます。 |
function(options, ...) | |
初期化アプリ(options, name) | FirebaseApp インスタンスを作成して初期化します。詳細については、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。 |
initializeApp(options, config) | FirebaseApp インスタンスを作成して初期化します。 |
initializeServerApp(options, config) | FirebaseServerApp インスタンスを作成して初期化します。FirebaseServerApp は FirebaseApp に似ていますが、サーバー側レンダリング環境での実行のみを目的としています。ブラウザ環境から呼び出すと初期化が失敗します。詳細については、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。 |
インターフェース
インターフェース | 説明 |
---|---|
FirebaseApp | FirebaseApp は、サービスのコレクションの初期化情報を保持します。このコンストラクタを直接呼び出さないでください。代わりに initializeApp() を使用してアプリを作成します。 |
FirebaseAppSettings | initializeApp() に指定された構成オプション |
FirebaseOptions | Firebase 構成オブジェクト。Firebase Server API と正常に通信し、クライアント データを Firebase プロジェクトおよび Firebase アプリケーションに関連付けるために、サービスが必要とする一連のパラメータが含まれています。通常、このオブジェクトは、プロジェクトのセットアップ時に Firebase コンソールによって入力されます。Firebase 構成オブジェクトの詳細もご覧ください。 |
FirebaseServerApp | FirebaseServerApp は、サーバー環境で実行されている一連のサービスの初期化情報を保持します。このコンストラクタを直接呼び出さないでください。代わりに、initializeServerApp() を使用してアプリを作成します。 |
FirebaseServerAppSettings | InitializeServerApp() に指定された構成オプション |
変数
変数 | 説明 |
---|---|
SDK_VERSION | 現在の SDK バージョン。 |
function(app, ...)
deleteApp(アプリ)
このアプリを使用できなくし、関連するすべてのサービスのリソースを解放します。
署名:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
app | FirebaseApp |
戻り値:
Promise<void>
例
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
function()
getApps()
初期化されたすべてのアプリの(読み取り専用)配列。
署名:
export declare function getApps(): FirebaseApp[];
戻り値:
initializeApp()
FirebaseApp インスタンスを作成して初期化します。
署名:
export declare function initializeApp(): FirebaseApp;
戻り値:
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
プラットフォーム ロギングの目的でライブラリの名前とバージョンを登録します。
署名:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
libraryKeyOrName | string | |
バージョン | string | そのライブラリの現在のバージョン。 |
バリアント | string | バンドルのバリエーション(node、rn など) |
戻り値:
void
function(logCallback, ...)
onLog(logCallback, options)
すべての Firebase SDK のログハンドラを設定します。
署名:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
logCallback | LogCallback | null | Firebase SDK がロギング呼び出しを行うたびにユーザーコードを実行する、オプションのカスタム ログハンドラ。 |
オプション | LogOptions |
戻り値:
void
function(logLevel, ...)
setLogLevel(logLevel)
すべての Firebase SDK のログレベルを設定します。
現在のログレベルを超えるすべてのログタイプがキャプチャされます(つまり、ログレベルを info
に設定すると、エラーは記録されますが、debug
ログと verbose
ログはキャプチャされません)。
署名:
export declare function setLogLevel(logLevel: LogLevelString): void;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
logLevel | LogLevelString |
戻り値:
void
function(name, ...)
getApp(name)
FirebaseApp インスタンスを取得します。
引数なしで呼び出すと、デフォルトのアプリが返されます。アプリ名を指定すると、その名前に対応するアプリが返されます。
取得対象のアプリがまだ初期化されていない場合は、例外がスローされます。
署名:
export declare function getApp(name?: string): FirebaseApp;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
name | string | 返されるアプリの名前(省略可)。名前を指定しない場合、デフォルトは "[DEFAULT]" です。 |
戻り値:
提供されたアプリ名に対応するアプリ。アプリ名を指定しない場合は、デフォルトのアプリが返されます。
例 1
// Return the default app
const app = getApp();
例 2
// Return a named app
const otherApp = getApp("otherApp");
function(options, ...)
InitializeApp(options, name)
FirebaseApp インスタンスを作成して初期化します。
詳しくは、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。
署名:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
オプション | FirebaseOptions | アプリのサービスを構成するオプション。 |
name | string | 初期化するアプリの名前(省略可)。名前を指定しない場合、デフォルトは "[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");
InitializeApp(options, config)
FirebaseApp インスタンスを作成して初期化します。
署名:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
オプション | FirebaseOptions | アプリのサービスを構成するオプション。 |
config | FirebaseAppSettings | FirebaseApp の構成 |
戻り値:
initServerApp(options, config)
FirebaseServerApp インスタンスを作成して初期化します。
FirebaseServerApp
は FirebaseApp
に似ていますが、サーバーサイド レンダリング環境での実行のみを想定しています。ブラウザ環境から呼び出した場合、初期化は失敗します。
詳しくは、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。
署名:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
オプション | FirebaseOptions | FirebaseApp | アプリのサービスを構成する Firebase.AppOptions 、または AppOptions を内部に含む FirebaseApp インスタンス。 |
config | FirebaseServerAppSettings | FirebaseServerApp 構成。 |
戻り値:
初期化された FirebaseServerApp
。
例
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
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
},
{
authIdToken: "Your Auth ID Token"
});
SDK_VERSION
現在の SDK バージョン。
署名:
SDK_VERSION: string