@firebase/messaging 0.12.4-canary.f3067f72d → 0.12.4-canary.f497a400a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/index.esm.js +4 -4
- package/dist/esm/index.esm.js.map +1 -1
- package/dist/esm/index.esm2017.js +4 -4
- package/dist/esm/index.esm2017.js.map +1 -1
- package/dist/esm/index.sw.esm2017.js.map +1 -1
- package/dist/esm/src/api.d.ts +3 -3
- package/dist/esm/src/interfaces/public-types.d.ts +10 -10
- package/dist/index-public.d.ts +13 -13
- package/dist/index.cjs.js +4 -4
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.sw.cjs.map +1 -1
- package/dist/internal.d.ts +13 -13
- package/dist/private.d.ts +13 -13
- package/dist/src/api.d.ts +3 -3
- package/dist/src/interfaces/public-types.d.ts +10 -10
- package/dist/sw/index-public.d.ts +10 -10
- package/dist/sw/internal.d.ts +10 -10
- package/dist/sw/private.d.ts +10 -10
- package/package.json +7 -7
package/dist/index-public.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export declare function deleteToken(messaging: Messaging): Promise<boolean>;
|
|
|
22
22
|
/**
|
|
23
23
|
* Options for features provided by the FCM SDK for Web. See {@link
|
|
24
24
|
* https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
|
|
25
|
-
* WebpushFcmOptions}
|
|
25
|
+
* WebpushFcmOptions}.
|
|
26
26
|
*
|
|
27
27
|
* @public
|
|
28
28
|
*/
|
|
@@ -46,15 +46,15 @@ export declare interface FcmOptions {
|
|
|
46
46
|
*/
|
|
47
47
|
export declare function getMessaging(app?: FirebaseApp): Messaging;
|
|
48
48
|
/**
|
|
49
|
-
* Subscribes the {@link Messaging} instance to push notifications. Returns
|
|
49
|
+
* Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
|
|
50
50
|
* Messaging registration token that can be used to send push messages to that {@link Messaging}
|
|
51
51
|
* instance.
|
|
52
52
|
*
|
|
53
|
-
* If
|
|
53
|
+
* If notification permission isn't already granted, this method asks the user for permission. The
|
|
54
54
|
* returned promise rejects if the user does not allow the app to show notifications.
|
|
55
55
|
*
|
|
56
56
|
* @param messaging - The {@link Messaging} instance.
|
|
57
|
-
* @param options - Provides an optional vapid key and an
|
|
57
|
+
* @param options - Provides an optional vapid key and an optional service worker registration.
|
|
58
58
|
*
|
|
59
59
|
* @returns The promise resolves with an FCM registration token.
|
|
60
60
|
*
|
|
@@ -62,18 +62,18 @@ export declare function getMessaging(app?: FirebaseApp): Messaging;
|
|
|
62
62
|
*/
|
|
63
63
|
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
|
|
64
64
|
/**
|
|
65
|
-
* Options for {@link getToken}
|
|
65
|
+
* Options for {@link getToken}.
|
|
66
66
|
*
|
|
67
67
|
* @public
|
|
68
68
|
*/
|
|
69
69
|
export declare interface GetTokenOptions {
|
|
70
70
|
/**
|
|
71
|
-
* The public server key provided to push services.
|
|
72
|
-
* authenticate
|
|
71
|
+
* The public server key provided to push services. The key is used to
|
|
72
|
+
* authenticate push subscribers to receive push messages only from sending servers that hold
|
|
73
73
|
* the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
|
|
74
74
|
* push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
|
|
75
75
|
* to generate and import a VAPID key for your project with
|
|
76
|
-
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#
|
|
76
|
+
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
|
|
77
77
|
* See
|
|
78
78
|
* {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
|
|
79
79
|
* for details on web push services.
|
|
@@ -83,7 +83,7 @@ export declare interface GetTokenOptions {
|
|
|
83
83
|
* The service worker registration for receiving push
|
|
84
84
|
* messaging. If the registration is not provided explicitly, you need to have a
|
|
85
85
|
* `firebase-messaging-sw.js` at your root location. See
|
|
86
|
-
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#
|
|
86
|
+
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
|
|
87
87
|
* for more details.
|
|
88
88
|
*/
|
|
89
89
|
serviceWorkerRegistration?: ServiceWorkerRegistration;
|
|
@@ -115,7 +115,7 @@ export declare function isSupported(): Promise<boolean>;
|
|
|
115
115
|
* Message payload that contains the notification payload that is represented with
|
|
116
116
|
* {@link NotificationPayload} and the data payload that contains an arbitrary
|
|
117
117
|
* number of key-value pairs sent by developers through the
|
|
118
|
-
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
|
|
118
|
+
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
|
|
119
119
|
*
|
|
120
120
|
* @public
|
|
121
121
|
*/
|
|
@@ -144,7 +144,7 @@ export declare interface MessagePayload {
|
|
|
144
144
|
*/
|
|
145
145
|
collapseKey: string;
|
|
146
146
|
/**
|
|
147
|
-
* The message
|
|
147
|
+
* The message ID of a message.
|
|
148
148
|
*/
|
|
149
149
|
messageId: string;
|
|
150
150
|
}
|
|
@@ -161,8 +161,8 @@ export declare interface Messaging {
|
|
|
161
161
|
}
|
|
162
162
|
export { NextFn };
|
|
163
163
|
/**
|
|
164
|
-
* Display notification details.
|
|
165
|
-
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
|
|
164
|
+
* Display notification details. Details are sent through the
|
|
165
|
+
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
|
|
166
166
|
*
|
|
167
167
|
* @public
|
|
168
168
|
*/
|
package/dist/index.cjs.js
CHANGED
|
@@ -1271,7 +1271,7 @@ function messageEventListener(messaging, event) {
|
|
|
1271
1271
|
}
|
|
1272
1272
|
|
|
1273
1273
|
var name = "@firebase/messaging";
|
|
1274
|
-
var version = "0.12.4-canary.
|
|
1274
|
+
var version = "0.12.4-canary.f497a400a";
|
|
1275
1275
|
|
|
1276
1276
|
/**
|
|
1277
1277
|
* @license
|
|
@@ -1472,15 +1472,15 @@ function getMessagingInWindow(app$1) {
|
|
|
1472
1472
|
return app._getProvider(util.getModularInstance(app$1), 'messaging').getImmediate();
|
|
1473
1473
|
}
|
|
1474
1474
|
/**
|
|
1475
|
-
* Subscribes the {@link Messaging} instance to push notifications. Returns
|
|
1475
|
+
* Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
|
|
1476
1476
|
* Messaging registration token that can be used to send push messages to that {@link Messaging}
|
|
1477
1477
|
* instance.
|
|
1478
1478
|
*
|
|
1479
|
-
* If
|
|
1479
|
+
* If notification permission isn't already granted, this method asks the user for permission. The
|
|
1480
1480
|
* returned promise rejects if the user does not allow the app to show notifications.
|
|
1481
1481
|
*
|
|
1482
1482
|
* @param messaging - The {@link Messaging} instance.
|
|
1483
|
-
* @param options - Provides an optional vapid key and an
|
|
1483
|
+
* @param options - Provides an optional vapid key and an optional service worker registration.
|
|
1484
1484
|
*
|
|
1485
1485
|
* @returns The promise resolves with an FCM registration token.
|
|
1486
1486
|
*
|