Interface NotificationsApi

Plugin interface functions.

See

Notifications REST API for further details.

interface NotificationsApi {
    acknowledge(id: NotificationId): void;
    acknowledgeAll(): void;
    clear(id: NotificationId): void;
    getId(id: NotificationId): AlarmProperties | undefined;
    getPath(path: Path): Record<NotificationId, AlarmProperties>;
    list(): Record<NotificationId, AlarmProperties>;
    mob(message?: string): NotificationId;
    raise(options: AlarmRaiseOptions): NotificationId;
    silence(id: NotificationId): void;
    silenceAll(): void;
    update(id: NotificationId, options: AlarmUpdateOptions): void;
}

Index

Notifications API

acknowledge acknowledgeAll clear getId getPath list mob raise silence silenceAll update

Notifications API

acknowledge

acknowledge(id: NotificationId): void
Acknowledge the alarm condition of the notification with the supplied identifier. Sets status.acknowledged = true Removes sound from method Note: Calling this method on a Notifications with a status of canAcknowledge = false will throw an Error
Parameters
- id: NotificationId
  Notification identifier.
Returns void
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.acknowledge('9922c05a-2813-4995-ab72-33f8f2246ff7')
```
- Defined in packages/server-api/src/notificationsapi.ts:230

acknowledgeAll

acknowledgeAll(): void
Acknowledges all notifications.

Returns void
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.acknowledgeAll()
```
- Defined in packages/server-api/src/notificationsapi.ts:245

clear

clear(id: NotificationId): void
Clears the alarm from the notification with the supplied identifier by setting state = normal Note: Calling this method on a Notifications with a status of canClear = false will throw an Error
Parameters
- id: NotificationId
  Notification identifier.
Returns void
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.clear('9922c05a-2813-4995-ab72-33f8f2246ff7')
```
- Defined in packages/server-api/src/notificationsapi.ts:264

getId

getId(id: NotificationId): AlarmProperties | undefined
Retrieve the notification with the supplied identifier.
Parameters
- id: NotificationId
  Notification identifier.
Returns AlarmProperties | undefined
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.getId('9922c05a-2813-4995-ab72-33f8f2246ff7')
```
- Defined in packages/server-api/src/notificationsapi.ts:45

getPath

getPath(path: Path): Record<NotificationId, AlarmProperties>
Retrieve the notification(s) with the supplied path.

When core notification management is disabled, entries are read from the data model (self context only): values carry no core-side status, keys are the source-supplied value.id when present (otherwise the notification path), and matching is by subtree (path prefix) rather than exact path.
Parameters
- path: Path
  Notification path.
Returns Record<NotificationId, AlarmProperties>
Example
```
app.notifications.getPath('notifications.server.newVersion')
```
- Defined in packages/server-api/src/notificationsapi.ts:65

list

list(): Record<NotificationId, AlarmProperties>
Retrieve a list notifications keyed by identifier.

When core notification management is disabled, entries are read from the data model (self context only): values carry no core-side status, and keys are the source-supplied value.id when present, otherwise the notification path.

Returns Record<NotificationId, AlarmProperties>
Example
```
app.notifications.list()
```
- Defined in packages/server-api/src/notificationsapi.ts:82

mob

mob(message?: string): NotificationId
Raise a Person Overboard (MOB) notification.
Parameters
- Optionalmessage: string
  Message to display or speak.
Returns NotificationId
Notification Identifier
Example: Raise MOB with default message ('Person Overboard!')
```
app.notifications.mob()

// path = `notifications.mob.{notificationId}`
```
Example: Raise MOB with specified message
```
app.notifications.mob('Crew member overboard!')
```
- Defined in packages/server-api/src/notificationsapi.ts:153

raise

raise(options: AlarmRaiseOptions): NotificationId
Raises a new notification and assigns an identifier.
Parameters
- options: AlarmRaiseOptions
  Alarm options.
Returns NotificationId
Notification Identifier
Example: Raise notification with minimum information
```
app.notifications.raise({
 state: 'warn',
 message: 'Port engine temperature is higher than normal.'
})

// path = `notifications.{notificationId}`
```
Example: Raise notification specifying the path
```
app.notifications.raise({
 state: 'warn',
 message: 'Port engine temperature is higher than normal.',
 path: 'propulsion.port.temperature'
})
```
Example: Raise notification specifying the path and append notification id
```
app.notifications.raise({
 state: 'warn',
 message: 'Port engine temperature is higher than normal.',
 path: 'propulsion.port.temperature',
 idInPath: true
})

// path = `notifications.propulsion.port.temperature.{notificationId}`
```
Note: when core notification management is disabled (notifications.manageNotifications = false), path is required — there is no notifications.{notificationId} fallback — and a plain Error is thrown if it is missing. The returned id is embedded in the emitted value but not tracked by the server. context is ignored: the notification is emitted for the self context, matching managed-mode emission.
- Defined in packages/server-api/src/notificationsapi.ts:130

silence

silence(id: NotificationId): void
Silence the alarm of the notification with the supplied identifier. Sets status.silenced = true Removes sound from method Note: Calling this method on a Notifications with a status of canSilence = false will throw an Error
Parameters
- id: NotificationId
  Notification identifier.
Returns void
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.silence('9922c05a-2813-4995-ab72-33f8f2246ff7')
```
- Defined in packages/server-api/src/notificationsapi.ts:196

silenceAll

silenceAll(): void
Silences all notifications.

Returns void
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.silenceAll()
```
- Defined in packages/server-api/src/notificationsapi.ts:211

update

update(id: NotificationId, options: AlarmUpdateOptions): void
Update the notification with the supplied identifier.
Parameters
- id: NotificationId
  Notification identifier.
- options: AlarmUpdateOptions
  Alarm options.
Returns void
Throws
NotificationManagerDisabledError when core notification management is disabled (notifications.manageNotifications = false).
Example
```
app.notifications.update(
 '9922c05a-2813-4995-ab72-33f8f2246ff7',
 {
   state: 'alarm',
   message: 'Port engine temperature is dangerously high!'
 }
)
```
- Defined in packages/server-api/src/notificationsapi.ts:177

Interface NotificationsApi

See

Index

Notifications API

Notifications API

acknowledge

Parameters

Returns void

Throws

Example

acknowledgeAll

Returns void

Throws

Example

clear

Parameters

Returns void

Throws

Example

getId

Parameters

Returns AlarmProperties | undefined

Throws

Example

getPath

Parameters

Returns Record<NotificationId, AlarmProperties>

Example

list

Returns Record<NotificationId, AlarmProperties>

Example

mob

Parameters

Returns NotificationId

Example: Raise MOB with default message ('Person Overboard!')

Example: Raise MOB with specified message

raise

Parameters

Returns NotificationId

Example: Raise notification with minimum information

Example: Raise notification specifying the path

Example: Raise notification specifying the path and append notification id

silence

Parameters

Returns void

Throws

Example

silenceAll

Returns void

Throws

Example

update

Parameters

Returns void

Throws

Example

On This Page