Class NotificationManager

Notification manager

Implements

IDisposable

Index

Constructors

Properties

_changed _isDisposed _queue

Accessors

changed count isDisposed notifications

Methods

dismiss dispose has notify update

Constructors

constructor

new NotificationManager(): NotificationManager
Returns NotificationManager
- Defined in packages/apputils/src/notification.ts:14

Properties

`Private` _changed

_changed: Signal<NotificationManager, IChange>

`Private` _isDisposed

_isDisposed: boolean

`Private` _queue

_queue: INotification<ReadonlyJSONValue>[]

Accessors

changed

get changed(): ISignal<NotificationManager, IChange>
Signal emitted whenever a notification changes.

Returns ISignal<NotificationManager, IChange>
- Defined in packages/apputils/src/notification.ts:23

count

get count(): number
Total number of notifications.

Returns number
- Defined in packages/apputils/src/notification.ts:30

isDisposed

get isDisposed(): boolean
Whether the manager is disposed or not.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in packages/apputils/src/notification.ts:37

notifications

get notifications(): INotification<ReadonlyJSONValue>[]
The list of notifications.

Returns INotification<ReadonlyJSONValue>[]
- Defined in packages/apputils/src/notification.ts:44

Methods

dismiss

dismiss(id?): void
Dismiss one notification (specified by its id) or all if no id provided.
Parameters
- Optional id: string
  Notification id
Returns void
- Defined in packages/apputils/src/notification.ts:53

dispose

dispose(): void
Dispose the manager.

Returns void
Implementation of IDisposable.dispose
- Defined in packages/apputils/src/notification.ts:78

has

has(id): boolean
Test whether a notification exists or not.
Parameters
- id: string
  Notification id
Returns boolean
Notification status
- Defined in packages/apputils/src/notification.ts:93

notify

notify<T>(message, type, options): string
Add a new notification.

This will trigger the changed signal with an added event.
Type Parameters
- T extends ReadonlyJSONValue = ReadonlyJSONValue
Parameters
- message: string
  Notification message
- type: TypeOptions
  Notification type
- options: Notification.IOptions<T>
  Notification option
Returns string
Notification unique id
- Defined in packages/apputils/src/notification.ts:107

update

update<T>(args): boolean
Update an existing notification.

If the notification does not exists this won't do anything.

Once updated the notification will be moved at the begin of the notification stack.
Type Parameters
- T extends ReadonlyJSONValue = ReadonlyJSONValue
Parameters
- args: IUpdate<T>
  Update options
Returns boolean
Whether the update was successful or not.
- Defined in packages/apputils/src/notification.ts:152