messaging.api

API Report File for "@firebase/messaging"

Do not edit this file. It is a report generated by API Extractor.

import { FirebaseApp } from '@firebase/app';
import { NextFn } from '@firebase/util';
import { Observer } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';

// @public
export function deleteToken(messaging: Messaging): Promise<boolean>;

// @public
export interface FcmOptions {
    analyticsLabel?: string;
    link?: string;
}

// @public
export function getMessaging(app?: FirebaseApp): Messaging;

// @public
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

// @public
export interface GetTokenOptions {
    serviceWorkerRegistration?: ServiceWorkerRegistration;
    vapidKey?: string;
}

// @public
export function isSupported(): Promise<boolean>;

// @public
export interface MessagePayload {
    collapseKey: string;
    data?: {
        [key: string]: string;
    };
    fcmOptions?: FcmOptions;
    from: string;
    messageId: string;
    notification?: NotificationPayload;
}

// @public
export interface Messaging {
    app: FirebaseApp;
}

export { NextFn }

// @public
export interface NotificationPayload {
    body?: string;
    icon?: string;
    image?: string;
    title?: string;
}

export { Observer }

// @public
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

export { Unsubscribe }