mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-03-17 09:01:07 +08:00
docs(): add interfaces
This commit is contained in:
parent
3385c1b6dc
commit
44fe04bbbd
@ -2,6 +2,30 @@ import { Cordova, Plugin } from './plugin';
|
|||||||
import { Observable } from 'rxjs/Observable';
|
import { Observable } from 'rxjs/Observable';
|
||||||
|
|
||||||
export interface OSNotification {
|
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;
|
app_id: string;
|
||||||
contents: any;
|
contents: any;
|
||||||
headings?: any;
|
headings?: any;
|
||||||
@ -82,33 +106,6 @@ export enum OSLockScreenVisibility {
|
|||||||
Secret = -1
|
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.
|
* 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();
|
* OneSignal.endInit();
|
||||||
* ```
|
* ```
|
||||||
* @interfaces
|
* @interfaces
|
||||||
* OneSignalNotification
|
* OSNotification
|
||||||
|
* OSLockScreenVisibility
|
||||||
|
* OSDisplayType
|
||||||
|
* OSNotificationPayload
|
||||||
|
* OSActionButton
|
||||||
|
* OSBackgroundImageLayout
|
||||||
|
* OSNotificationOpenedResult
|
||||||
|
* OSActionType
|
||||||
*/
|
*/
|
||||||
@Plugin({
|
@Plugin({
|
||||||
pluginName: 'OneSignal',
|
pluginName: 'OneSignal',
|
||||||
|
Loading…
x
Reference in New Issue
Block a user