Class NotificationManager

Notification manager

Hierarchy

NotificationManager

Implements

IDisposable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NotificationManager(): NotificationManager

- Defined in packages/apputils/lib/notification.d.ts:7
Returns NotificationManager

Properties

Private _changed

_changed: any

Private _isDisposed

_isDisposed: any

Private _queue

_queue: any

Accessors

changed

get changed(): ISignal<NotificationManager, IChange>

- Defined in packages/apputils/lib/notification.d.ts:12
Signal emitted whenever a notification changes.

Returns ISignal<NotificationManager, IChange>

count

get count(): number

- Defined in packages/apputils/lib/notification.d.ts:16
Total number of notifications.

Returns number

isDisposed

get isDisposed(): boolean

- Defined in packages/apputils/lib/notification.d.ts:20
Whether the manager is disposed or not.

Returns boolean

notifications

get notifications(): INotification<ReadonlyJSONValue>[]

- Defined in packages/apputils/lib/notification.d.ts:24
The list of notifications.

Returns INotification<ReadonlyJSONValue>[]

Methods

dismiss

dismiss(id?: string): void

- Defined in packages/apputils/lib/notification.d.ts:30
Dismiss one notification (specified by its id) or all if no id provided.

Parameters
- Optional id: string
  
  Notification id
Returns void

dispose

dispose(): void

Implementation of IDisposable.dispose
- Defined in packages/apputils/lib/notification.d.ts:34
Dispose the manager.

Returns void

has

has(id: string): boolean

- Defined in packages/apputils/lib/notification.d.ts:41
Test whether a notification exists or not.

Parameters
- id: string
  
  Notification id
Returns boolean

Notification status

notify

notify<T>(message: string, type: TypeOptions, options: IOptions<T>): string

- Defined in packages/apputils/lib/notification.d.ts:52
Add a new notification.

This will trigger the changed signal with an added event.

Type parameters
- T: ReadonlyJSONValue = ReadonlyJSONValue
Parameters
- message: string
  
  Notification message
- type: TypeOptions
  
  Notification type
- options: IOptions<T>
  
  Notification option
Returns string

Notification unique id

update

update<T>(args: IUpdate<T>): boolean

- Defined in packages/apputils/lib/notification.d.ts:64
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: ReadonlyJSONValue = ReadonlyJSONValue
Parameters
- args: IUpdate<T>
  
  Update options
Returns boolean

Whether the update was successful or not.

Generated using TypeDoc