関数
| 関数 | 説明 |
|---|---|
| function(app, ...) | |
| getMessaging(app) | Firebase Cloud Messaging インスタンスを取得します。 |
| function(messaging, ...) | |
| deleteToken(messaging) | この Messaging インスタンスに関連付けられている登録トークンを削除し、Messaging インスタンスを push サブスクリプションから登録解除します。 |
| getToken(messaging, options) | Messaging インスタンスをプッシュ通知に登録します。その Messaging インスタンスに push メッセージを送信するために使用できる Firebase Cloud Messaging 登録トークンを返します。通知権限がまだ付与されていない場合、このメソッドはユーザーに権限をリクエストします。ユーザーがアプリに通知の表示を許可しない場合、返される Promise は拒否されます。 |
| onMessage(messaging, nextOrObserver) | プッシュ メッセージを受信してユーザーが現在オリジンのページにアクセスすると、メッセージがページに渡され、プッシュ メッセージのペイロードとともに onMessage() イベントがディスパッチされます。 |
| function（） | |
| isSupported() | 必要なすべての API がブラウザに存在するかどうかを確認します。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| FcmOptions | ウェブ用 FCM SDK によって提供される機能のオプション。WebpushFcmOptions をご覧ください。 |
| GetTokenOptions | getToken() のオプション。 |
| MessagePayload | NotificationPayload で表される通知ペイロードと、デベロッパーが Send API を介して送信した任意の数の Key-Value ペアを含むデータ ペイロードを含むメッセージ ペイロード。 |
| メッセージ | Firebase Cloud Messaging SDK の公開インターフェース。 |
| NotificationPayload | 通知の詳細を表示します。詳細は Send API によって送信されます。 |
関数（アプリ、...）
getMessaging（アプリ）
Firebase Cloud Messaging インスタンスを取得します。
署名:
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | FirebaseApp |
戻り値:
指定された Firebase アプリに関連付けられている Firebase Cloud Messaging インスタンス。
関数（メッセージング, ...）
deleteToken(messaging)
この Messaging インスタンスに関連付けられている登録トークンを削除し、Messaging インスタンスを push サブスクリプションから登録解除します。
署名:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| メッセージング | メッセージ | Messaging インスタンス。 |
戻り値:
Promise<boolean>
トークンが正常に削除されると、Promise は解決されます。
getToken(メッセージ, オプション)
Messaging インスタンスをプッシュ通知に登録します。その Messaging インスタンスに push メッセージを送信するために使用できる Firebase Cloud Messaging 登録トークンを返します。
通知権限がまだ付与されていない場合、このメソッドはユーザーに権限をリクエストします。ユーザーがアプリに通知の表示を許可しない場合、返される Promise は拒否されます。
署名:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| メッセージング | メッセージ | Messaging インスタンス。 |
| オプション | GetTokenOptions | オプションの vapid キーと Service Worker 登録（省略可）を提供します。 |
戻り値:
Promise<文字列>
Promise は FCM 登録トークンで解決されます。
onMessage(Messaging, nextOrObserver)
プッシュ メッセージを受信してユーザーが現在オリジンのページにアクセスすると、メッセージがページに渡され、プッシュ メッセージのペイロードとともに onMessage() イベントがディスパッチされます。
署名:
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| メッセージング | メッセージ | Messaging インスタンス。 |
| nextOrObserver | NextFn<MessagePayload>|オブザーバー<MessagePayload> | この関数（next が定義されたオブザーバー オブジェクト）は、メッセージを受信してユーザーが現在ページを閲覧しているときに呼び出されます。 |
戻り値:
メッセージのリッスンを停止するには、この返された関数を実行します。
関数
isSupported()
必要なすべての API がブラウザに存在するかどうかを確認します。
署名:
export declare function isWindowSupported(): Promise<boolean>;
戻り値:
Promise<boolean>
ブール値に解決される Promise。