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