mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-01 02:53:03 +08:00
feat(local-notifications): Support latest beta
feat(local-notifications): Support latest beta
This commit is contained in:
Daniel Sogl
GitHub
commit
ff4a61d0ec
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "ionic-native",
|
||||
"version": "4.5.2",
|
||||
"version": "4.6.0",
|
||||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
|
||||
@ -1,5 +1,195 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs/Observable';
|
||||
|
||||
export enum ELocalNotificationTriggerUnit {
|
||||
SECOND = 'second',
|
||||
MINUTE = 'minute',
|
||||
HOUR = 'hour',
|
||||
DAY = 'day',
|
||||
WEEK = 'week',
|
||||
MONTH = 'month',
|
||||
QUARTER = 'quarter',
|
||||
YEAR = 'year',
|
||||
WEEKDAY = 'weekday',
|
||||
WEEKDAY_ORDINAL = 'weekdayOrdinal',
|
||||
WEEK_OF_MONTH = 'weekOfMonth'
|
||||
}
|
||||
|
||||
export interface ILocalNotificationTrigger {
|
||||
|
||||
/** ***** FIX ***** */
|
||||
|
||||
/**
|
||||
* The date and time when the system should deliver the local notification. If the specified value is nil or is a date in the past, the local notification is delivered immediately.
|
||||
* Default: now ~ new Date()
|
||||
*/
|
||||
at?: Date;
|
||||
|
||||
/** ***** TIMESPAN ***** */
|
||||
|
||||
/**
|
||||
* Amount of units
|
||||
*/
|
||||
in?: number;
|
||||
|
||||
/**
|
||||
* Unit
|
||||
*/
|
||||
unit?: ELocalNotificationTriggerUnit;
|
||||
|
||||
/** ***** REPEAT/MATCH ***** */
|
||||
|
||||
/**
|
||||
* Amount of units
|
||||
*/
|
||||
count?: number;
|
||||
|
||||
/**
|
||||
* The unit
|
||||
*/
|
||||
every?: ELocalNotificationTriggerUnit;
|
||||
|
||||
/**
|
||||
* The end of the repeating notification
|
||||
*/
|
||||
before?: Date;
|
||||
|
||||
/**
|
||||
* The date and time when the system should deliver the local notification. If the specified value is nil or is a date in the past, the local notification is delivered immediately.
|
||||
* Only for "repeat"
|
||||
* Default: now ~ new Date()
|
||||
*/
|
||||
firstAt?: Date;
|
||||
|
||||
/**
|
||||
* Only for "match"
|
||||
*/
|
||||
after?: Date;
|
||||
|
||||
/** ***** LOCATION ***** */
|
||||
|
||||
/**
|
||||
* IOS ONLY
|
||||
* Center of the location
|
||||
* Latitude and Longitude values
|
||||
*/
|
||||
center?: number[];
|
||||
|
||||
/**
|
||||
* IOS ONLY
|
||||
* Radius in meters
|
||||
*/
|
||||
radius?: number;
|
||||
|
||||
/**
|
||||
* IOS ONLY
|
||||
* Trigger on entry of the location
|
||||
*/
|
||||
notifyOnEntry?: boolean;
|
||||
|
||||
/**
|
||||
* IOS ONLY
|
||||
* Trigger on exit of the location
|
||||
*/
|
||||
notifyOnExit?: boolean;
|
||||
|
||||
/**
|
||||
* IOS ONLY
|
||||
* Trigger only once?
|
||||
*/
|
||||
single?: boolean;
|
||||
}
|
||||
|
||||
export enum ILocalNotificationActionType {
|
||||
INPUT = 'input',
|
||||
BUTTON = 'button'
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification action
|
||||
*
|
||||
* @see https://github.com/katzer/cordova-plugin-local-notifications#actions
|
||||
*/
|
||||
export interface ILocalNotificationAction {
|
||||
/**
|
||||
* The id of the action is used as the event name in the listener function
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* The title of the notification message
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specifies whether the action causes the app to launch in the foreground
|
||||
*/
|
||||
launch?: boolean;
|
||||
|
||||
/**
|
||||
* If the value is 'decline' the action is displayed with special highlighting to indicate that it performs a destructive task
|
||||
*/
|
||||
ui?: string;
|
||||
|
||||
/**
|
||||
* Specifies whether the action requires that the user’s device be unlocked.
|
||||
* When the user selects an action with this option, the system prompts
|
||||
* the user to unlock the device
|
||||
*/
|
||||
needsAuth?: boolean;
|
||||
|
||||
/**
|
||||
* The resource path of the action icon
|
||||
*/
|
||||
icon?: string;
|
||||
|
||||
/**
|
||||
* The type of the action. If omitted 'button' is used.
|
||||
*/
|
||||
type?: ILocalNotificationActionType;
|
||||
}
|
||||
|
||||
export interface ILocalNotificationProgressBar {
|
||||
/**
|
||||
* Is the progress bar enabled?
|
||||
*/
|
||||
enabled?: boolean;
|
||||
|
||||
/**
|
||||
* The current value
|
||||
*/
|
||||
value?: number;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* The maximum value (default is 100)
|
||||
*/
|
||||
maxValue?: number;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Show an indeterminate progress bar
|
||||
*/
|
||||
indeterminate?: boolean;
|
||||
|
||||
/**
|
||||
* WINDOWS ONLY
|
||||
* Gets or sets an optional string to be displayed instead of the
|
||||
* default percentage string. If this isn't provided, something
|
||||
* like "70%" will be displayed.
|
||||
*/
|
||||
description?: string;
|
||||
|
||||
/**
|
||||
* WINDOWS ONLY
|
||||
* Sets the status (required), which is displayed underneath the progress bar
|
||||
* on the left.
|
||||
* This string should reflect the status of the operation,
|
||||
* like "Downloading..." or "Installing..."
|
||||
*/
|
||||
status?: string;
|
||||
}
|
||||
|
||||
export interface ILocalNotification {
|
||||
|
||||
@ -19,20 +209,7 @@ export interface ILocalNotification {
|
||||
* Second row of the notification
|
||||
* Default: Empty string
|
||||
*/
|
||||
text?: string;
|
||||
|
||||
/**
|
||||
* The interval at which to reschedule the local notification. That can be a value of second, minute, hour, day, week, month or year
|
||||
* Default: 0 (which means that the system triggers the local notification once)
|
||||
*/
|
||||
every?: string;
|
||||
|
||||
/**
|
||||
* The date and time when the system should deliver the local notification. If the specified value is nil or is a date in the past, the local notification is delivered immediately.
|
||||
* Default: now ~ new Date()
|
||||
*/
|
||||
at?: any;
|
||||
firstAt?: any;
|
||||
text?: string | string[];
|
||||
|
||||
/**
|
||||
* The number currently set as the badge of the app icon in Springboard (iOS) or at the right-hand side of the local notification (Android)
|
||||
@ -67,38 +244,159 @@ export interface ILocalNotification {
|
||||
smallIcon?: string;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* RGB value for the background color of the smallIcon.
|
||||
* Default: Androids COLOR_DEFAULT, which will vary based on Android version.
|
||||
*/
|
||||
* ANDROID ONLY
|
||||
* RGB value for the background color of the smallIcon.
|
||||
* Default: Androids COLOR_DEFAULT, which will vary based on Android version.
|
||||
*/
|
||||
color?: string;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Use the default notification vibrate.
|
||||
*/
|
||||
vibrate?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Ongoing notifications differ from regular notifications in the following ways:
|
||||
* - They are sorted above the regular notifications in the notification panel
|
||||
* - They do not have an 'X' close button, and are not affected by the "Clear all" button
|
||||
* Default: false
|
||||
* Define the blinking of the LED on the device.
|
||||
* If set to true, the LED will blink in the default color with
|
||||
* timings for on and off set to 1000 ms.
|
||||
* If set to a string, the LED will blink in this ARGB value with
|
||||
* timings for on and off set to 1000 ms.
|
||||
* If set to an array, the value of the key 0 will be used as the color,
|
||||
* the value of the key 1 will be used as the 'on' timing, the value of
|
||||
* the key 2 will be used as the 'off' timing
|
||||
*/
|
||||
ongoing?: boolean;
|
||||
led?: {color: string, on: number, off: number} | any[] | boolean | string;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* ARGB value that you would like the LED on the device to blink
|
||||
* Default: FFFFFF
|
||||
* Notification priority.
|
||||
* Integers between -2 and 2, whereas -2 is minimum and 2 is maximum priority
|
||||
*/
|
||||
led?: string;
|
||||
|
||||
/**
|
||||
* Notification priority.
|
||||
*/
|
||||
priority?: number;
|
||||
|
||||
/**
|
||||
* Is a silent notification
|
||||
*/
|
||||
silent?: boolean;
|
||||
|
||||
/**
|
||||
* Specifies whether the a click on the notification causes the app
|
||||
* to launch in the foreground
|
||||
*/
|
||||
launch?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Wakeup the device. (default is true)
|
||||
*/
|
||||
wakeup?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Specifies a duration in milliseconds after which this notification should be canceled, if it is not already canceled.
|
||||
*/
|
||||
timeoutAfter?: number | false;
|
||||
|
||||
/**
|
||||
* Actions id or actions
|
||||
*/
|
||||
actions?: string | ILocalNotificationAction[];
|
||||
|
||||
/**
|
||||
* When to trigger the notification
|
||||
*/
|
||||
trigger?: ILocalNotificationTrigger;
|
||||
|
||||
/**
|
||||
* A list of image attachments
|
||||
*/
|
||||
attachments?: string[];
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* If and how the notification shall show the when date.
|
||||
* Possbile values:
|
||||
* boolean: true equals 'clock', false disable a watch/counter
|
||||
* 'clock': Show the when date in the content view
|
||||
* 'chronometer': Show a stopwatch
|
||||
*
|
||||
*/
|
||||
clock?: boolean | string;
|
||||
|
||||
/**
|
||||
* Shows a progress bar
|
||||
* Setting a boolean is a shortcut for {enabled: true/false} respectively
|
||||
*/
|
||||
progressBar?: ILocalNotificationProgressBar | boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* If multiple notifications have the same group your app can present
|
||||
* them as a single group.
|
||||
*/
|
||||
group?: string;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* If set to 'true' this notification could use 'summary' to summarize
|
||||
* the contents of the whole group
|
||||
*/
|
||||
groupSummary?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Summary of the whole notification group. Should be used in conjuntion
|
||||
* with 'groupSummary' set to true
|
||||
*/
|
||||
summary?: string;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Sets the number of items this notification represents.
|
||||
*/
|
||||
number?: number;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Set whether this is an "ongoing" notification.
|
||||
* Ongoing notifications cannot be dismissed by the user,
|
||||
* so your application or service must take care of canceling them.
|
||||
*/
|
||||
sticky?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Make this notification automatically dismissed when the user touches it.
|
||||
*/
|
||||
autoClear?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* If set to true the notification will be show in its entirety on all lockscreens.
|
||||
* If set to false it will not be revealed on a secure lockscreen.
|
||||
*/
|
||||
lockscreen?: boolean;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Set the default notification options that will be used.
|
||||
* The value should be one or more of the following fields combined with
|
||||
* bitwise-or: DEFAULT_SOUND, DEFAULT_VIBRATE, DEFAULT_LIGHTS.
|
||||
*/
|
||||
defaults?: number;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Specifies the channel the notification should be delivered on.
|
||||
*/
|
||||
channel?: string;
|
||||
|
||||
/**
|
||||
* ANDROID ONLY
|
||||
* Set the token for the media session
|
||||
*/
|
||||
mediaSession?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -142,7 +440,7 @@ export interface ILocalNotification {
|
||||
* // Schedule delayed notification
|
||||
* this.localNotifications.schedule({
|
||||
* text: 'Delayed ILocalNotification',
|
||||
* at: new Date(new Date().getTime() + 3600),
|
||||
* trigger: {at: new Date(new Date().getTime() + 3600)},
|
||||
* led: 'FF0000',
|
||||
* sound: null
|
||||
* });
|
||||
@ -190,10 +488,7 @@ export class LocalNotifications extends IonicNativePlugin {
|
||||
* Clears all notifications
|
||||
* @returns {Promise<any>} Returns a promise when all notifications have cleared
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 0,
|
||||
errorIndex: 2
|
||||
})
|
||||
@Cordova()
|
||||
clearAll(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
@ -208,10 +503,7 @@ export class LocalNotifications extends IonicNativePlugin {
|
||||
* Cancels all notifications
|
||||
* @returns {Promise<any>} Returns a promise when all notifications are canceled
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 0,
|
||||
errorIndex: 2
|
||||
})
|
||||
@Cordova()
|
||||
cancelAll(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
@ -243,7 +535,7 @@ export class LocalNotifications extends IonicNativePlugin {
|
||||
* @returns {Promise<Array<number>>}
|
||||
*/
|
||||
@Cordova()
|
||||
getAllIds(): Promise<Array<number>> { return; }
|
||||
getIds(): Promise<Array<number>> { return; }
|
||||
|
||||
/**
|
||||
* Get the ids of triggered notifications
|
||||
@ -318,26 +610,75 @@ export class LocalNotifications extends IonicNativePlugin {
|
||||
@Cordova()
|
||||
hasPermission(): Promise<boolean> { return; }
|
||||
|
||||
/**
|
||||
* Adds a group of actions
|
||||
* @param groupId The id of the action group
|
||||
* @param actions The actions of this group
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
addActions(groupId: any, actions: Array<ILocalNotificationAction>): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Removes a group of actions
|
||||
* @param groupId The id of the action group
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
removeActions(groupId: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Checks if a group of actions is defined
|
||||
* @param groupId The id of the action group
|
||||
* @returns {Promise<boolean>} Whether the group is defined
|
||||
*/
|
||||
@Cordova()
|
||||
hasActions(groupId: any): Promise<boolean> { return; }
|
||||
|
||||
/**
|
||||
* Gets the (platform specific) default settings.
|
||||
* @returns {Promise<any>} An object with all default settings
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
getDefaults(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Overwrites the (platform specific) default settings.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
setDefaults(defaults: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Sets a callback for a specific event
|
||||
* @param eventName The name of the event. Available events: schedule, trigger, click, update, clear, clearall, cancel, cancelall
|
||||
* @param callback Call back function. All events return notification and state parameter. clear and clearall return state parameter only.
|
||||
* @param eventName {string} The name of the event. Available events: schedule, trigger, click, update, clear, clearall, cancel, cancelall. Custom event names are possible for actions
|
||||
* @return {Observable}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
observable: true,
|
||||
clearFunction: 'un',
|
||||
clearWithArgs: true
|
||||
})
|
||||
on(eventName: string, callback: any): void { }
|
||||
on(eventName: string): Observable<any> { return; }
|
||||
|
||||
/**
|
||||
* Removes a callback of a specific event
|
||||
* @param eventName The name of the event. Available events: schedule, trigger, click, update, clear, clearall, cancel, cancelall
|
||||
* @param callback Call back function. All events return notification and state parameter. clear and clearall return state parameter only.
|
||||
* Not an official interface, however its possible to manually fire events.
|
||||
** @param eventName The name of the event. Available events: schedule, trigger, click, update, clear, clearall, cancel, cancelall. Custom event names are possible for actions
|
||||
* @param args Optional arguments
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
un(eventName: string, callback: any): void { }
|
||||
|
||||
fireEvent(eventName: string, args: any): void { }
|
||||
|
||||
/**
|
||||
* Fire queued events once the device is ready and all listeners are registered.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
fireQueuedEvents(): Promise<any> { return; }
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user