index.d.ts 3.52 KB
Newer Older
1 2
declare module "react-native-fcm" {

Libin Lu's avatar
Libin Lu committed
3
    type FCMEventType = "FCMTokenRefreshed" | "FCMNotificationReceived" | 'FCMDirectChannelConnectionChanged';
4 5 6
    export module FCMEvent {
        const RefreshToken = "FCMTokenRefreshed";
        const Notification = "FCMNotificationReceived";
Libin Lu's avatar
Libin Lu committed
7
        const DirectChannelConnectionChanged: 'FCMDirectChannelConnectionChanged'
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
    }

    export module RemoteNotificationResult {
        const NewData = "UIBackgroundFetchResultNewData";
        const NoData = "UIBackgroundFetchResultNoData";
        const ResultFailed = "UIBackgroundFetchResultFailed";
    }

    export module WillPresentNotificationResult {
        const All = "UNNotificationPresentationOptionAll";
        const None = "UNNotificationPresentationOptionNone";
    }

    export module NotificationType {
        const Remote = "remote_notification";
        const NotificationResponse = "notification_response";
        const WillPresent = "will_present_notification";
        const Local = "local_notification";
    }

28 29 30 31 32 33 34 35 36
  export interface Notification {
        collapse_key: string;
        opened_from_tray: boolean;
        from: string;
        notification: {
            title?: string
            body: string;
            icon: string;
        };
37
        local_notification?: boolean;
38 39 40 41 42
        _notificationType: string;
        finish(type?: string): void;
    }

    export interface LocalNotification {
43
        id?: string;
44 45 46 47
        title?: string;
        body: string;
        icon?: string;
        vibrate?: number;
Baptiste MORELLE's avatar
Baptiste MORELLE committed
48
        sound?: string;
49
        big_text?: string;
50 51
        sub_text?: string;
        color?: string;
52
        large_icon?: string;
53 54 55 56 57 58 59 60 61 62 63
        priority?: string;
        show_in_foreground?: boolean;
        click_action?: string;
        badge?: number; 
        number?: number;
        ticker?: string;
        auto_cancel?: boolean;
        tag?: string;
        group?: string;
        picture?: string;
        my_custom_data?: string;
Libin Lu's avatar
Libin Lu committed
64 65
        ongoing?: boolean;
        lights?: boolean;
66 67 68 69
    }

    export interface ScheduleLocalNotification extends LocalNotification{
        id: string;
70 71
        fire_date: number;
        repeat_interval?: "week" | "day" | "hour"
72 73
    }

74 75 76 77 78
    export interface Subscription {
        remove(): void;
    }

    export class FCM {
Libin Lu's avatar
Libin Lu committed
79
        static requestPermissions(): Promise<void>;
80 81
        static getFCMToken(): Promise<string>;
        static on(event: "FCMTokenRefreshed", handler: (token: string) => void): Subscription;
82
        static on(event: "FCMNotificationReceived", handler: (notification: Notification) => void): Subscription;
83 84
        static subscribeToTopic(topic: string): void;
        static unsubscribeFromTopic(topic: string): void;
85 86
        static getInitialNotification(): Promise<Notification>;
        static presentLocalNotification(notification: LocalNotification): void;
87

Libin Lu's avatar
Libin Lu committed
88
        static scheduleLocalNotification(schedule: ScheduleLocalNotification): void;
89
        static getScheduledLocalNotifications(): Promise<LocalNotification>;
90 91 92 93 94 95 96 97 98 99

        static removeAllDeliveredNotifications(): void;
        static removeDeliveredNotification(id: string): void;

        static cancelAllLocalNotifications(): void;
        static cancelLocalNotification(id: string): string;

        static setBadgeNumber(badge: number): void;
        static getBadgeNumber(): Promise<number>;
        static send(id: string, data: any): void;
Libin Lu's avatar
Libin Lu committed
100 101 102 103

        static enableDirectChannel(): void
        static isDirectChannelEstablished(): Promise<boolean>
        static getAPNSToken(): Promise<string>
104 105 106 107
    }

    export default FCM;
}