definitions.d.ts

import { PushNotificationsPlugin } from '@capacitor/core';
import {
  LocalNotificationsPlugin,
  PushNotification,
  PushNotificationActionPerformed,
  PushNotificationToken
} from '@capacitor/core/dist/esm/core-plugin-definitions';
import { PluginListenerHandle } from '@capacitor/core/dist/esm/definitions';

declare module '@capacitor/core' {
  interface PluginRegistry {
    NotificationExtension: NotificationExtension;
  }
}

export interface LocalNotificationExtension extends LocalNotificationsPlugin {}

export interface NotificationExtension extends PushNotificationsPlugin {
  /**
   * @deprecated Use getToken() instead.
   */
  addListener(eventName: 'registration', listenerFunc: (token: PushNotificationToken) => void): PluginListenerHandle;

  addListener(eventName: 'registrationError', listenerFunc: (error: any) => void): PluginListenerHandle;

  addListener(eventName: 'pushNotificationReceived', listenerFunc: (notification: PushNotification) => void): PluginListenerHandle;

  addListener(eventName: 'pushNotificationActionPerformed', listenerFunc: (notification: PushNotificationActionPerformed) => void): PluginListenerHandle;

  /**
   * Get FCM token from client with promise.
   * Use this method to get token rather than waiting 'registration' event listener
   * to control the procedure of initializing application.
   */
  getToken(): Promise<{ value: string }>

  /**
   * Save the range of time to SQLite to filtering push notification when it is received.
   * Push notification won't shown when current time is out of range.
   * Time format should be a 24 hour clock like HH:mm, in user's timezone.
   * @param options
   */
  addTimeFilter(options: { startFrom: string, endAt: string }): Promise<void>

  /**
   * Remove time filter which added with addTimeFilter method.
   */
  removeTimeFilter(): Promise<void>

  /**
   * Save the key - boolean field to SQLite to filtering push notification when it is received.
   * Push notification won't shown when any of the value from matched keys exists with 'false' value.
   * Can detailed filter with saved value.
   * @param options
   */
  addFilters(options: { filters: string[] }): Promise<void>

  /**
   * Find all rows that have key matched with filters and make value to 'true'
   * to not ignore push notification.
   * @param options
   */
  removeFilters(options: { filters: string[] }): Promise<void>

  /**
   * Get all filters which contains time filter
   */
  getFilters(): Promise<{ value: Array<{ [props: string]: string }> }>
}