Notifier
OCP App SDK / Notifier
Interface: Notifier
Defined in: src/notifications/Notifier.ts:1
Methods
error()
Defined in: src/notifications/Notifier.ts:36
Create an error notification.
Parameters
activity
string
The activity, must not be empty
title
string
The title, must not be empty
summary
string
The activity summary, must not be empty
details?
string
The activity details
Returns
Promise<void>
info()
Defined in: src/notifications/Notifier.ts:9
Create an informational notification.
Parameters
activity
string
The activity, must not be empty
title
string
The title, must not be empty
summary
string
The activity summary, must not be empty
details?
string
The activity details
Returns
Promise<void>
success()
Defined in: src/notifications/Notifier.ts:18
Create a success notification.
Parameters
activity
string
The activity, must not be empty
title
string
The title, must not be empty
summary
string
The activity summary, must not be empty
details?
string
The activity details
Returns
Promise<void>
warn()
Defined in: src/notifications/Notifier.ts:27
Create a warning notification.
Parameters
activity
string
The activity, must not be empty
title
string
The title, must not be empty
summary
string
The activity summary, must not be empty
details?
string
The activity details
Returns
Promise<void>