Class UnraidModule

Hierarchy

Index

Constructors

constructor

Methods

Constructors

constructor

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

Inherited from UnraidModuleCaseModelExtension.constructor
- Defined in modules/unraid/unraid-module.ts:31
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
Returns UnraidModule

Methods

deleteNotification

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

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

getCaseModel

getCaseModel(): Promise<string>

Inherited from UnraidModuleCaseModelExtension.getCaseModel
- Defined in modules/unraid/extensions/casemodel.ts:4
Returns Promise<string>

getIdentConfig

getIdentConfig(): Promise<IdentConfig>

Inherited from UnraidModuleIdentConfigExtension.getIdentConfig
- Defined in modules/unraid/extensions/identconfig.ts:53
Returns /boot/config/ident.cfg as parsed JSON

Returns Promise<IdentConfig>

getNotificationCount

getNotificationCount(): Promise<NotificationCount>

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

Returns Promise<NotificationCount>

getNotifications

getNotifications(): Promise<RichNotification[]>

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

Returns Promise<RichNotification[]>

getUserScriptSchedule

getUserScriptSchedule(): Promise<IUserScriptSchedule>

Inherited from UnraidModuleUserScriptsExtension.getUserScriptSchedule
- Defined in modules/unraid/extensions/userscripts.ts:38
Returns Promise<IUserScriptSchedule>

getUserScripts

getUserScripts(): Promise<UserScript[]>

Inherited from UnraidModuleUserScriptsExtension.getUserScripts
- Defined in modules/unraid/extensions/userscripts.ts:44
Returns Promise<UserScript[]>

hasUserScriptsInstalled

hasUserScriptsInstalled(): Promise<boolean>

Inherited from UnraidModuleUserScriptsExtension.hasUserScriptsInstalled
- Defined in modules/unraid/extensions/userscripts.ts:33
Returns Promise<boolean>

setCaseModel

setCaseModel(caseModel: string): Promise<void>

Inherited from UnraidModuleCaseModelExtension.setCaseModel
- Defined in modules/unraid/extensions/casemodel.ts:11
Parameters
- caseModel: string
Returns Promise<void>

toggleNotificationArchiveState

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

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

Generated using TypeDoc