|
1 | | -## API Report File for "@firebase/messaging-exp" |
2 | | - |
3 | | -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
4 | | -
|
5 | | -```ts |
6 | | - |
7 | | -import { FirebaseApp } from '@firebase/app-exp'; |
8 | | -import { NextFn } from '@firebase/util'; |
9 | | -import { Observer } from '@firebase/util'; |
10 | | -import { Unsubscribe } from '@firebase/util'; |
11 | | - |
12 | | -// @public |
13 | | -export function deleteToken(messaging: Messaging): Promise<boolean>; |
14 | | - |
15 | | -// @public |
16 | | -export interface FcmOptions { |
17 | | - analyticsLabel?: string; |
18 | | - link?: string; |
19 | | -} |
20 | | - |
21 | | -// @public |
22 | | -export function getMessaging(app?: FirebaseApp): Messaging; |
23 | | - |
24 | | -// @public |
25 | | -export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>; |
26 | | - |
27 | | -// @public |
28 | | -export interface GetTokenOptions { |
29 | | - serviceWorkerRegistration?: ServiceWorkerRegistration; |
30 | | - vapidKey?: string; |
31 | | -} |
32 | | - |
33 | | -// @public |
34 | | -export function isSupported(): Promise<boolean>; |
35 | | - |
36 | | -// @public |
37 | | -export interface MessagePayload { |
38 | | - collapseKey: string; |
39 | | - data?: { |
40 | | - [key: string]: string; |
41 | | - }; |
42 | | - fcmOptions?: FcmOptions; |
43 | | - from: string; |
44 | | - messageId: string; |
45 | | - notification?: NotificationPayload; |
46 | | -} |
47 | | - |
48 | | -// @public |
49 | | -export interface Messaging { |
50 | | -} |
51 | | - |
52 | | -export { NextFn } |
53 | | - |
54 | | -// @public |
55 | | -export interface NotificationPayload { |
56 | | - body?: string; |
57 | | - image?: string; |
58 | | - title?: string; |
59 | | -} |
60 | | - |
61 | | -export { Observer } |
62 | | - |
63 | | -// @public |
64 | | -export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe; |
65 | | - |
66 | | -export { Unsubscribe } |
67 | | - |
68 | | - |
69 | | -``` |
| 1 | +## API Report File for "@firebase/messaging-exp" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | + |
| 7 | +import { FirebaseApp } from '@firebase/app-exp'; |
| 8 | +import { NextFn } from '@firebase/util'; |
| 9 | +import { Observer } from '@firebase/util'; |
| 10 | +import { Unsubscribe } from '@firebase/util'; |
| 11 | + |
| 12 | +// @public |
| 13 | +export function deleteToken(messaging: Messaging): Promise<boolean>; |
| 14 | + |
| 15 | +// @public |
| 16 | +export interface FcmOptions { |
| 17 | + analyticsLabel?: string; |
| 18 | + link?: string; |
| 19 | +} |
| 20 | + |
| 21 | +// @public |
| 22 | +export function getMessaging(app?: FirebaseApp): Messaging; |
| 23 | + |
| 24 | +// @public |
| 25 | +export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>; |
| 26 | + |
| 27 | +// @public |
| 28 | +export interface GetTokenOptions { |
| 29 | + serviceWorkerRegistration?: ServiceWorkerRegistration; |
| 30 | + vapidKey?: string; |
| 31 | +} |
| 32 | + |
| 33 | +// @public |
| 34 | +export function isSupported(): Promise<boolean>; |
| 35 | + |
| 36 | +// @public |
| 37 | +export interface MessagePayload { |
| 38 | + collapseKey: string; |
| 39 | + data?: { |
| 40 | + [key: string]: string; |
| 41 | + }; |
| 42 | + fcmOptions?: FcmOptions; |
| 43 | + from: string; |
| 44 | + messageId: string; |
| 45 | + notification?: NotificationPayload; |
| 46 | +} |
| 47 | + |
| 48 | +// @public |
| 49 | +export interface Messaging { |
| 50 | + app: FirebaseApp; |
| 51 | +} |
| 52 | + |
| 53 | +export { NextFn } |
| 54 | + |
| 55 | +// @public |
| 56 | +export interface NotificationPayload { |
| 57 | + body?: string; |
| 58 | + image?: string; |
| 59 | + title?: string; |
| 60 | +} |
| 61 | + |
| 62 | +export { Observer } |
| 63 | + |
| 64 | +// @public |
| 65 | +export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe; |
| 66 | + |
| 67 | +export { Unsubscribe } |
| 68 | + |
| 69 | + |
| 70 | +``` |
0 commit comments