github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-01-19 16:52:53 +08:00
Code Issues Projects Releases Wiki Activity

docs(): add interfaces

Browse Source
This commit is contained in:
Ibby 2016-12-27 08:03:21 -05:00
parent 3385c1b6dc
commit 44fe04bbbd
1 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
src/plugins/onesignal.ts
View File

@ -2,6 +2,30 @@ import { Cordova, Plugin } from './plugin';
import { Observable } from 'rxjs/Observable';
export interface OSNotification {
/**
* Was app in focus.
*/
isAppInFocus: boolean;
/**
* Was notification shown to the user. Will be false for silent notifications.
*/
shown: boolean;
/**
* **ANDROID** - Android Notification assigned to the notification. Can be used to cancel or replace the notification.
*/
androidNotificationId?: number;
/**
* Payload received from OneSignal.
*/
payload: OSNotificationPayload;
/**
* How the notification was displayed to the user. Can be set to `Notification`, `InAppAlert`, or `None` if it was not displayed.
*/
displayType: OSDisplayType;
/**
* **ANDROID** - Notification is a summary notification for a group this will contain all notification payloads it was created from.
*/
groupedNotifications?: OSNotificationPayload[];
app_id: string;
contents: any;
headings?: any;
@ -82,33 +106,6 @@ export enum OSLockScreenVisibility {
Secret = -1
}
export interface OSNotification {
/**
* Was app in focus.
*/
isAppInFocus: boolean;
/**
* Was notification shown to the user. Will be false for silent notifications.
*/
shown: boolean;
/**
* **ANDROID** - Android Notification assigned to the notification. Can be used to cancel or replace the notification.
*/
androidNotificationId?: number;
/**
* Payload received from OneSignal.
*/
payload: OSNotificationPayload;
/**
* How the notification was displayed to the user. Can be set to `Notification`, `InAppAlert`, or `None` if it was not displayed.
*/
displayType: OSDisplayType;
/**
* **ANDROID** - Notification is a summary notification for a group this will contain all notification payloads it was created from.
*/
groupedNotifications?: OSNotificationPayload[];
}
/**
* How the notification was displayed to the user. Part of OSNotification. See inFocusDisplaying for more information on how this is used.
*/
@ -289,7 +286,14 @@ export enum OSActionType {
* OneSignal.endInit();
* ```
* @interfaces
* OneSignalNotification
* OSNotification
* OSLockScreenVisibility
* OSDisplayType
* OSNotificationPayload
* OSActionButton
* OSBackgroundImageLayout
* OSNotificationOpenedResult
* OSActionType
*/
@Plugin({
pluginName: 'OneSignal',