firebase-admin.instance-id package

Firebase インスタンス ID サービス。

関数

関数 説明
getInstanceId(app) デフォルト アプリまたは特定のアプリの InstanceId サービスを取得します。この API は非推奨になりました。getInstallations() API を使用して、インスタンス ID と Firebase インストール ID を削除することをおすすめします。getInstanceId() を引数なしで呼び出すことで、デフォルト アプリの InstanceId サービスにアクセスするか、getInstanceId(app) として呼び出し、特定のアプリに関連付けられた InstanceId サービスにアクセスできます。

クラス

クラス 説明
FirebaseInstanceIdError Firebase インスタンス ID のエラーコードの構造。これは FirebaseError を拡張します。
インスタンス ID InstanceId サービスを使用すると、Firebase クライアント アプリのインスタンスに関連付けられている Firebase インスタンス ID を削除できます。
InstanceIdClientErrorCode

getInstanceId(アプリ)

<ph type="x-smartling-placeholder">
</ph>

代わりに getInstallations() を使用してください。

デフォルト アプリまたは特定のアプリの InstanceId サービスを取得します。

この API は非推奨となりました。getInstallations() API を使用してインスタンス ID と Firebase インストール ID を削除することをおすすめします。

getInstanceId() を引数なしで呼び出すと、デフォルト アプリの InstanceId サービスにアクセスできます。getInstanceId(app) として呼び出すと、特定のアプリに関連付けられた InstanceId サービスにアクセスできるようになります。

署名:

export declare function getInstanceId(app?: App): InstanceId;

パラメータ

パラメータ 説明
アプリ アプリ InstanceId サービスを返すオプションのアプリ。指定しない場合は、デフォルトの InstanceId サービスが返されます。

戻り値:

インスタンス ID

アプリが指定されていない場合はデフォルトの InstanceId サービス、または指定されたアプリに関連付けられた InstanceId サービス。

例 1

// Get the Instance ID service for the default app
const defaultInstanceId = getInstanceId();

例 2

// Get the Instance ID service for a given app
const otherInstanceId = getInstanceId(otherApp);

この API は非推奨となりました。admin.installations() API を使用してインスタンス ID と Firebase インストール ID を削除することをおすすめします。