@firebase/messaging 0.12.13 → 0.12.14
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.esm2017.js +1173 -1173
- package/dist/esm/index.esm2017.js.map +1 -1
- package/dist/esm/index.sw.esm2017.js +1228 -1228
- package/dist/esm/index.sw.esm2017.js.map +1 -1
- package/dist/esm/src/api/deleteToken.d.ts +18 -18
- package/dist/esm/src/api/getToken.d.ts +19 -19
- package/dist/esm/src/api/isSupported.d.ts +30 -30
- package/dist/esm/src/api/onBackgroundMessage.d.ts +19 -19
- package/dist/esm/src/api/onMessage.d.ts +19 -19
- package/dist/esm/src/api/setDeliveryMetricsExportedToBigQueryEnabled.d.ts +18 -18
- package/dist/esm/src/api.d.ts +101 -101
- package/dist/esm/src/helpers/array-base64-translator.d.ts +18 -18
- package/dist/esm/src/helpers/array-base64-translator.test.d.ts +17 -17
- package/dist/esm/src/helpers/externalizePayload.d.ts +19 -19
- package/dist/esm/src/helpers/externalizePayload.test.d.ts +17 -17
- package/dist/esm/src/helpers/extract-app-config.d.ts +19 -19
- package/dist/esm/src/helpers/extract-app-config.test.d.ts +17 -17
- package/dist/esm/src/helpers/is-console-message.d.ts +18 -18
- package/dist/esm/src/helpers/logToFirelog.d.ts +30 -30
- package/dist/esm/src/helpers/logToFirelog.test.d.ts +17 -17
- package/dist/esm/src/helpers/logToScion.d.ts +19 -19
- package/dist/esm/src/helpers/migrate-old-database.d.ts +51 -51
- package/dist/esm/src/helpers/migrate-old-database.test.d.ts +17 -17
- package/dist/esm/src/helpers/register.d.ts +23 -23
- package/dist/esm/src/helpers/registerDefaultSw.d.ts +18 -18
- package/dist/esm/src/helpers/sleep.d.ts +18 -18
- package/dist/esm/src/helpers/sleep.test.d.ts +17 -17
- package/dist/esm/src/helpers/updateSwReg.d.ts +18 -18
- package/dist/esm/src/helpers/updateVapidKey.d.ts +18 -18
- package/dist/esm/src/index.d.ts +32 -32
- package/dist/esm/src/index.sw.d.ts +26 -26
- package/dist/esm/src/interfaces/app-config.d.ts +24 -24
- package/dist/esm/src/interfaces/internal-dependencies.d.ts +27 -27
- package/dist/esm/src/interfaces/internal-message-payload.d.ts +65 -46
- package/dist/esm/src/interfaces/logging-types.d.ts +60 -60
- package/dist/esm/src/interfaces/public-types.d.ts +144 -144
- package/dist/esm/src/interfaces/token-details.d.ts +32 -32
- package/dist/esm/src/internals/idb-manager.d.ts +27 -27
- package/dist/esm/src/internals/idb-manager.test.d.ts +17 -17
- package/dist/esm/src/internals/requests.d.ts +35 -35
- package/dist/esm/src/internals/requests.test.d.ts +17 -17
- package/dist/esm/src/internals/token-manager.d.ts +23 -23
- package/dist/esm/src/internals/token-manager.test.d.ts +17 -17
- package/dist/esm/src/listeners/sw-listeners.d.ts +21 -21
- package/dist/esm/src/listeners/sw-listeners.test.d.ts +17 -17
- package/dist/esm/src/listeners/window-listener.d.ts +18 -18
- package/dist/esm/src/messaging-service.d.ts +36 -36
- package/dist/esm/src/testing/compare-headers.d.ts +22 -22
- package/dist/esm/src/testing/compare-headers.test.d.ts +17 -17
- package/dist/esm/src/testing/fakes/firebase-dependencies.d.ts +25 -25
- package/dist/esm/src/testing/fakes/logging-object.d.ts +18 -18
- package/dist/esm/src/testing/fakes/messaging-service.d.ts +18 -18
- package/dist/esm/src/testing/fakes/service-worker.d.ts +83 -83
- package/dist/esm/src/testing/fakes/token-details.d.ts +18 -18
- package/dist/esm/src/testing/setup.d.ts +17 -17
- package/dist/esm/src/testing/sinon-types.d.ts +19 -19
- package/dist/esm/src/util/constants.d.ts +39 -39
- package/dist/esm/src/util/errors.d.ts +57 -57
- package/dist/esm/src/util/sw-types.d.ts +90 -90
- package/dist/index.cjs.js +1173 -1173
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.sw.cjs +1228 -1228
- package/dist/index.sw.cjs.map +1 -1
- package/dist/src/api/deleteToken.d.ts +18 -18
- package/dist/src/api/getToken.d.ts +19 -19
- package/dist/src/api/isSupported.d.ts +30 -30
- package/dist/src/api/onBackgroundMessage.d.ts +19 -19
- package/dist/src/api/onMessage.d.ts +19 -19
- package/dist/src/api/setDeliveryMetricsExportedToBigQueryEnabled.d.ts +18 -18
- package/dist/src/api.d.ts +101 -101
- package/dist/src/helpers/array-base64-translator.d.ts +18 -18
- package/dist/src/helpers/array-base64-translator.test.d.ts +17 -17
- package/dist/src/helpers/externalizePayload.d.ts +19 -19
- package/dist/src/helpers/externalizePayload.test.d.ts +17 -17
- package/dist/src/helpers/extract-app-config.d.ts +19 -19
- package/dist/src/helpers/extract-app-config.test.d.ts +17 -17
- package/dist/src/helpers/is-console-message.d.ts +18 -18
- package/dist/src/helpers/logToFirelog.d.ts +30 -30
- package/dist/src/helpers/logToFirelog.test.d.ts +17 -17
- package/dist/src/helpers/logToScion.d.ts +19 -19
- package/dist/src/helpers/migrate-old-database.d.ts +51 -51
- package/dist/src/helpers/migrate-old-database.test.d.ts +17 -17
- package/dist/src/helpers/register.d.ts +23 -23
- package/dist/src/helpers/registerDefaultSw.d.ts +18 -18
- package/dist/src/helpers/sleep.d.ts +18 -18
- package/dist/src/helpers/sleep.test.d.ts +17 -17
- package/dist/src/helpers/updateSwReg.d.ts +18 -18
- package/dist/src/helpers/updateVapidKey.d.ts +18 -18
- package/dist/src/index.d.ts +32 -32
- package/dist/src/index.sw.d.ts +26 -26
- package/dist/src/interfaces/app-config.d.ts +24 -24
- package/dist/src/interfaces/internal-dependencies.d.ts +27 -27
- package/dist/src/interfaces/internal-message-payload.d.ts +65 -46
- package/dist/src/interfaces/logging-types.d.ts +60 -60
- package/dist/src/interfaces/public-types.d.ts +144 -144
- package/dist/src/interfaces/token-details.d.ts +32 -32
- package/dist/src/internals/idb-manager.d.ts +27 -27
- package/dist/src/internals/idb-manager.test.d.ts +17 -17
- package/dist/src/internals/requests.d.ts +35 -35
- package/dist/src/internals/requests.test.d.ts +17 -17
- package/dist/src/internals/token-manager.d.ts +23 -23
- package/dist/src/internals/token-manager.test.d.ts +17 -17
- package/dist/src/listeners/sw-listeners.d.ts +21 -21
- package/dist/src/listeners/sw-listeners.test.d.ts +17 -17
- package/dist/src/listeners/window-listener.d.ts +18 -18
- package/dist/src/messaging-service.d.ts +36 -36
- package/dist/src/testing/compare-headers.d.ts +22 -22
- package/dist/src/testing/compare-headers.test.d.ts +17 -17
- package/dist/src/testing/fakes/firebase-dependencies.d.ts +25 -25
- package/dist/src/testing/fakes/logging-object.d.ts +18 -18
- package/dist/src/testing/fakes/messaging-service.d.ts +18 -18
- package/dist/src/testing/fakes/service-worker.d.ts +83 -83
- package/dist/src/testing/fakes/token-details.d.ts +18 -18
- package/dist/src/testing/setup.d.ts +17 -17
- package/dist/src/testing/sinon-types.d.ts +19 -19
- package/dist/src/util/constants.d.ts +39 -39
- package/dist/src/util/errors.d.ts +57 -57
- package/dist/src/util/sw-types.d.ts +90 -90
- package/package.json +8 -8
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
/**
|
|
18
|
-
* Checks if all required APIs exist in the browser.
|
|
19
|
-
* @returns a Promise that resolves to a boolean.
|
|
20
|
-
*
|
|
21
|
-
* @public
|
|
22
|
-
*/
|
|
23
|
-
export declare function isWindowSupported(): Promise<boolean>;
|
|
24
|
-
/**
|
|
25
|
-
* Checks whether all required APIs exist within SW Context
|
|
26
|
-
* @returns a Promise that resolves to a boolean.
|
|
27
|
-
*
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
|
-
export declare function isSwSupported(): Promise<boolean>;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* Checks if all required APIs exist in the browser.
|
|
19
|
+
* @returns a Promise that resolves to a boolean.
|
|
20
|
+
*
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export declare function isWindowSupported(): Promise<boolean>;
|
|
24
|
+
/**
|
|
25
|
+
* Checks whether all required APIs exist within SW Context
|
|
26
|
+
* @returns a Promise that resolves to a boolean.
|
|
27
|
+
*
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export declare function isSwSupported(): Promise<boolean>;
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { MessagePayload, NextFn, Observer, Unsubscribe } from '../interfaces/public-types';
|
|
18
|
-
import { MessagingService } from '../messaging-service';
|
|
19
|
-
export declare function onBackgroundMessage(messaging: MessagingService, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { MessagePayload, NextFn, Observer, Unsubscribe } from '../interfaces/public-types';
|
|
18
|
+
import { MessagingService } from '../messaging-service';
|
|
19
|
+
export declare function onBackgroundMessage(messaging: MessagingService, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { MessagePayload, NextFn, Observer, Unsubscribe } from '../interfaces/public-types';
|
|
18
|
-
import { MessagingService } from '../messaging-service';
|
|
19
|
-
export declare function onMessage(messaging: MessagingService, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { MessagePayload, NextFn, Observer, Unsubscribe } from '../interfaces/public-types';
|
|
18
|
+
import { MessagingService } from '../messaging-service';
|
|
19
|
+
export declare function onMessage(messaging: MessagingService, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { Messaging } from '../interfaces/public-types';
|
|
18
|
-
export declare function _setDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { Messaging } from '../interfaces/public-types';
|
|
18
|
+
export declare function _setDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
|
package/dist/src/api.d.ts
CHANGED
|
@@ -1,101 +1,101 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2017 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { FirebaseApp } from '@firebase/app';
|
|
18
|
-
import { GetTokenOptions, MessagePayload, Messaging } from './interfaces/public-types';
|
|
19
|
-
import { NextFn, Observer, Unsubscribe } from '@firebase/util';
|
|
20
|
-
/**
|
|
21
|
-
* Retrieves a Firebase Cloud Messaging instance.
|
|
22
|
-
*
|
|
23
|
-
* @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
|
|
24
|
-
*
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
|
-
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
|
|
28
|
-
/**
|
|
29
|
-
* Retrieves a Firebase Cloud Messaging instance.
|
|
30
|
-
*
|
|
31
|
-
* @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
|
|
32
|
-
*
|
|
33
|
-
* @public
|
|
34
|
-
*/
|
|
35
|
-
export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
|
|
36
|
-
/**
|
|
37
|
-
* Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
|
|
38
|
-
* Messaging registration token that can be used to send push messages to that {@link Messaging}
|
|
39
|
-
* instance.
|
|
40
|
-
*
|
|
41
|
-
* If notification permission isn't already granted, this method asks the user for permission. The
|
|
42
|
-
* returned promise rejects if the user does not allow the app to show notifications.
|
|
43
|
-
*
|
|
44
|
-
* @param messaging - The {@link Messaging} instance.
|
|
45
|
-
* @param options - Provides an optional vapid key and an optional service worker registration.
|
|
46
|
-
*
|
|
47
|
-
* @returns The promise resolves with an FCM registration token.
|
|
48
|
-
*
|
|
49
|
-
* @public
|
|
50
|
-
*/
|
|
51
|
-
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
|
|
52
|
-
/**
|
|
53
|
-
* Deletes the registration token associated with this {@link Messaging} instance and unsubscribes
|
|
54
|
-
* the {@link Messaging} instance from the push subscription.
|
|
55
|
-
*
|
|
56
|
-
* @param messaging - The {@link Messaging} instance.
|
|
57
|
-
*
|
|
58
|
-
* @returns The promise resolves when the token has been successfully deleted.
|
|
59
|
-
*
|
|
60
|
-
* @public
|
|
61
|
-
*/
|
|
62
|
-
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
|
|
63
|
-
/**
|
|
64
|
-
* When a push message is received and the user is currently on a page for your origin, the
|
|
65
|
-
* message is passed to the page and an `onMessage()` event is dispatched with the payload of
|
|
66
|
-
* the push message.
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* @param messaging - The {@link Messaging} instance.
|
|
70
|
-
* @param nextOrObserver - This function, or observer object with `next` defined,
|
|
71
|
-
* is called when a message is received and the user is currently viewing your page.
|
|
72
|
-
* @returns To stop listening for messages execute this returned function.
|
|
73
|
-
*
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
|
-
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
77
|
-
/**
|
|
78
|
-
* Called when a message is received while the app is in the background. An app is considered to be
|
|
79
|
-
* in the background if no active window is displayed.
|
|
80
|
-
*
|
|
81
|
-
* @param messaging - The {@link Messaging} instance.
|
|
82
|
-
* @param nextOrObserver - This function, or observer object with `next` defined, is called when a
|
|
83
|
-
* message is received and the app is currently in the background.
|
|
84
|
-
*
|
|
85
|
-
* @returns To stop listening for messages execute this returned function
|
|
86
|
-
*
|
|
87
|
-
* @public
|
|
88
|
-
*/
|
|
89
|
-
export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
90
|
-
/**
|
|
91
|
-
* Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
|
|
92
|
-
* default, message delivery metrics are not exported to BigQuery. Use this method to enable or
|
|
93
|
-
* disable the export at runtime.
|
|
94
|
-
*
|
|
95
|
-
* @param messaging - The `FirebaseMessaging` instance.
|
|
96
|
-
* @param enable - Whether Firebase Cloud Messaging should export message delivery metrics to
|
|
97
|
-
* BigQuery.
|
|
98
|
-
*
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2017 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { FirebaseApp } from '@firebase/app';
|
|
18
|
+
import { GetTokenOptions, MessagePayload, Messaging } from './interfaces/public-types';
|
|
19
|
+
import { NextFn, Observer, Unsubscribe } from '@firebase/util';
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves a Firebase Cloud Messaging instance.
|
|
22
|
+
*
|
|
23
|
+
* @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
|
|
24
|
+
*
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
|
|
28
|
+
/**
|
|
29
|
+
* Retrieves a Firebase Cloud Messaging instance.
|
|
30
|
+
*
|
|
31
|
+
* @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
|
|
32
|
+
*
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
|
|
36
|
+
/**
|
|
37
|
+
* Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
|
|
38
|
+
* Messaging registration token that can be used to send push messages to that {@link Messaging}
|
|
39
|
+
* instance.
|
|
40
|
+
*
|
|
41
|
+
* If notification permission isn't already granted, this method asks the user for permission. The
|
|
42
|
+
* returned promise rejects if the user does not allow the app to show notifications.
|
|
43
|
+
*
|
|
44
|
+
* @param messaging - The {@link Messaging} instance.
|
|
45
|
+
* @param options - Provides an optional vapid key and an optional service worker registration.
|
|
46
|
+
*
|
|
47
|
+
* @returns The promise resolves with an FCM registration token.
|
|
48
|
+
*
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
|
|
52
|
+
/**
|
|
53
|
+
* Deletes the registration token associated with this {@link Messaging} instance and unsubscribes
|
|
54
|
+
* the {@link Messaging} instance from the push subscription.
|
|
55
|
+
*
|
|
56
|
+
* @param messaging - The {@link Messaging} instance.
|
|
57
|
+
*
|
|
58
|
+
* @returns The promise resolves when the token has been successfully deleted.
|
|
59
|
+
*
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
|
|
63
|
+
/**
|
|
64
|
+
* When a push message is received and the user is currently on a page for your origin, the
|
|
65
|
+
* message is passed to the page and an `onMessage()` event is dispatched with the payload of
|
|
66
|
+
* the push message.
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
* @param messaging - The {@link Messaging} instance.
|
|
70
|
+
* @param nextOrObserver - This function, or observer object with `next` defined,
|
|
71
|
+
* is called when a message is received and the user is currently viewing your page.
|
|
72
|
+
* @returns To stop listening for messages execute this returned function.
|
|
73
|
+
*
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
77
|
+
/**
|
|
78
|
+
* Called when a message is received while the app is in the background. An app is considered to be
|
|
79
|
+
* in the background if no active window is displayed.
|
|
80
|
+
*
|
|
81
|
+
* @param messaging - The {@link Messaging} instance.
|
|
82
|
+
* @param nextOrObserver - This function, or observer object with `next` defined, is called when a
|
|
83
|
+
* message is received and the app is currently in the background.
|
|
84
|
+
*
|
|
85
|
+
* @returns To stop listening for messages execute this returned function
|
|
86
|
+
*
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
|
|
90
|
+
/**
|
|
91
|
+
* Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
|
|
92
|
+
* default, message delivery metrics are not exported to BigQuery. Use this method to enable or
|
|
93
|
+
* disable the export at runtime.
|
|
94
|
+
*
|
|
95
|
+
* @param messaging - The `FirebaseMessaging` instance.
|
|
96
|
+
* @param enable - Whether Firebase Cloud Messaging should export message delivery metrics to
|
|
97
|
+
* BigQuery.
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2017 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
export declare function arrayToBase64(array: Uint8Array | ArrayBuffer): string;
|
|
18
|
-
export declare function base64ToArray(base64String: string): Uint8Array;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2017 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
export declare function arrayToBase64(array: Uint8Array | ArrayBuffer): string;
|
|
18
|
+
export declare function base64ToArray(base64String: string): Uint8Array;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2017 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import '../testing/setup';
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2017 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import '../testing/setup';
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { MessagePayload } from '../interfaces/public-types';
|
|
18
|
-
import { MessagePayloadInternal } from '../interfaces/internal-message-payload';
|
|
19
|
-
export declare function externalizePayload(internalPayload: MessagePayloadInternal): MessagePayload;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { MessagePayload } from '../interfaces/public-types';
|
|
18
|
+
import { MessagePayloadInternal } from '../interfaces/internal-message-payload';
|
|
19
|
+
export declare function externalizePayload(internalPayload: MessagePayloadInternal): MessagePayload;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
export {};
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
export {};
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2019 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { FirebaseApp } from '@firebase/app';
|
|
18
|
-
import { AppConfig } from '../interfaces/app-config';
|
|
19
|
-
export declare function extractAppConfig(app: FirebaseApp): AppConfig;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2019 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { FirebaseApp } from '@firebase/app';
|
|
18
|
+
import { AppConfig } from '../interfaces/app-config';
|
|
19
|
+
export declare function extractAppConfig(app: FirebaseApp): AppConfig;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2019 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import '../testing/setup';
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2019 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import '../testing/setup';
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2019 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { ConsoleMessageData } from '../interfaces/internal-message-payload';
|
|
18
|
-
export declare function isConsoleMessage(data: unknown): data is ConsoleMessageData;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2019 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { ConsoleMessageData } from '../interfaces/internal-message-payload';
|
|
18
|
+
export declare function isConsoleMessage(data: unknown): data is ConsoleMessageData;
|