18
18
import { FirebaseApp } from '@firebase/app' ;
19
19
20
20
/**
21
- * Display notification details. They are sent through the
22
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
21
+ * Display notification details. Details are sent through the
22
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
23
23
*
24
24
* @public
25
25
*/
@@ -49,7 +49,7 @@ export interface NotificationPayload {
49
49
/**
50
50
* Options for features provided by the FCM SDK for Web. See {@link
51
51
* https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
52
- * WebpushFcmOptions}
52
+ * WebpushFcmOptions}.
53
53
*
54
54
* @public
55
55
*/
@@ -69,7 +69,7 @@ export interface FcmOptions {
69
69
* Message payload that contains the notification payload that is represented with
70
70
* {@link NotificationPayload} and the data payload that contains an arbitrary
71
71
* number of key-value pairs sent by developers through the
72
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
72
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
73
73
*
74
74
* @public
75
75
*/
@@ -101,24 +101,24 @@ export interface MessagePayload {
101
101
collapseKey : string ;
102
102
103
103
/**
104
- * The message id of a message.
104
+ * The message ID of a message.
105
105
*/
106
106
messageId : string ;
107
107
}
108
108
109
109
/**
110
- * Options for {@link getToken}
110
+ * Options for {@link getToken}.
111
111
*
112
112
* @public
113
113
*/
114
114
export interface GetTokenOptions {
115
115
/**
116
- * The public server key provided to push services. It is used to
117
- * authenticate the push subscribers to receive push messages only from sending servers that hold
116
+ * The public server key provided to push services. The key is used to
117
+ * authenticate push subscribers to receive push messages only from sending servers that hold
118
118
* the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
119
119
* push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
120
120
* to generate and import a VAPID key for your project with
121
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
121
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
122
122
* See
123
123
* {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
124
124
* for details on web push services.
@@ -128,7 +128,7 @@ export interface GetTokenOptions {
128
128
* The service worker registration for receiving push
129
129
* messaging. If the registration is not provided explicitly, you need to have a
130
130
* `firebase-messaging-sw.js` at your root location. See
131
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
131
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
132
132
* for more details.
133
133
*/
134
134
serviceWorkerRegistration ?: ServiceWorkerRegistration ;
0 commit comments