Class UnraidModuleNotificationExtension

Hierarchy

UnraidModuleExtensionBase
- UnraidModuleNotificationExtension
  - UnraidModule

Index

Constructors

constructor

Properties

instance

Methods

Constructors

constructor

new UnraidModuleNotificationExtension(instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>): UnraidModuleNotificationExtension

Inherited from UnraidModuleExtensionBase.constructor
- Defined in modules/unraid/unraid-module-extension-base.ts:6
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
Returns UnraidModuleNotificationExtension

Properties

Readonly instance

instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>

Methods

deleteNotification

deleteNotification(notificationName: string, isArchived: boolean): Promise<void>

- Defined in modules/unraid/extensions/notifications.ts:96
Parameters
- notificationName: string
- isArchived: boolean
Returns Promise<void>

getNotificationCount

getNotificationCount(): Promise<NotificationCount>

- Defined in modules/unraid/extensions/notifications.ts:83
Returns UNRAID Notification count.

Returns Promise<NotificationCount>

getNotifications

getNotifications(): Promise<RichNotification[]>

- Defined in modules/unraid/extensions/notifications.ts:44
Returns UNRAID Notifications sorted by date.

Returns Promise<RichNotification[]>

toggleNotificationArchiveState

toggleNotificationArchiveState(notificationName: string, isArchived: boolean): Promise<void>

- Defined in modules/unraid/extensions/notifications.ts:103
Parameters
- notificationName: string
- isArchived: boolean
Returns Promise<void>

Generated using TypeDoc