firebase-admin.instance-id package

使用できます。

関数

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

クラス

クラス 説明
InstanceId InstanceId サービスを使用すると、Firebase クライアント アプリのインスタンスに関連付けられている Firebase インスタンス ID を削除できます。

getInstanceId(アプリ)

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

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

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

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

署名:

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

パラメータ

パラメータ 説明
app アプリ InstanceId サービスを返す省略可能なアプリ。指定されていない場合は、デフォルトの InstanceId サービスが返されます。

戻り値:

InstanceId

アプリが指定されていない場合は、デフォルトの 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 は非推奨になりました。インスタンス ID と Firebase インストール ID を削除するには、admin.installations() API を使用することをおすすめします。