Class NotificationManager

Hierarchy

MessageClient
- NotificationManager

Constructors

constructor

new NotificationManager(): NotificationManager
Returns NotificationManager
Inherited from MessageClient.constructor

Properties

`Protected` `Readonly` contentRenderer

contentRenderer: NotificationContentRenderer

`Protected` `Readonly` contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly` deferredResults

deferredResults: Map<string, Deferred<undefined | string>> = ...

`Protected` `Readonly` fireUpdatedEvent

fireUpdatedEvent: DebouncedFuncLeading<(() => void)> = ...

Type declaration

- (): void
- Returns void

`Protected` hideTimeouts

hideTimeouts: Map<string, number> = ...

`Protected` notificationCenterVisibleKey

notificationCenterVisibleKey: ContextKey<boolean>

`Protected` notificationToastsVisibleKey

notificationToastsVisibleKey: ContextKey<boolean>

`Protected` `Readonly` notifications

notifications: Map<string, Notification> = ...

`Protected` notificationsVisible

notificationsVisible: ContextKey<boolean>

`Readonly` onUpdated

onUpdated: Event<NotificationUpdateEvent> = ...

`Protected` `Readonly` onUpdatedEmitter

onUpdatedEmitter: Emitter<NotificationUpdateEvent> = ...

`Protected` `Readonly` openerService

openerService: OpenerService

`Protected` `Readonly` preferences

preferences: NotificationPreferences

`Protected` `Readonly` toasts

toasts: Map<string, Notification> = ...

`Protected` visibilityState

visibilityState: Visibility = 'hidden'

Accessors

centerVisible

get centerVisible(): boolean
Returns boolean
- Defined in packages/messages/src/browser/notifications-manager.ts:107

toastsVisible

get toastsVisible(): boolean
Returns boolean
- Defined in packages/messages/src/browser/notifications-manager.ts:104

Methods

accept

accept(notification, action): void
Parameters
- notification: string | Notification
- action: undefined | string
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:130

clear

clear(notification): void
Parameters
- notification: string | Notification
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:167

clearAll

clearAll(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:162

`Protected` doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/messages/src/browser/notifications-manager.ts:92

`Protected` find

find(notification): undefined | Notification
Parameters
- notification: string | Notification
Returns undefined | Notification
- Defined in packages/messages/src/browser/notifications-manager.ts:148

`Protected` getId

getId(notification): string
Parameters
- notification: string | Notification
Returns string
- Defined in packages/messages/src/browser/notifications-manager.ts:151

`Protected` getMessageId

getMessageId(m): string
Parameters
- m: Message
Returns string
- Defined in packages/messages/src/browser/notifications-manager.ts:252

`Protected` getTimeout

getTimeout(plainMessage): number
Parameters
- plainMessage: Message
Returns number
- Defined in packages/messages/src/browser/notifications-manager.ts:227

hide

hide(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:155

hideCenter

hideCenter(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:120

`Protected` hideToast

hideToast(messageId): void
Parameters
- messageId: string
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:219

`Protected` init

init(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:88

`Protected` isExpandable

isExpandable(message, source, actions): boolean
Parameters
- message: string
- source: undefined | string
- actions: string[]
Returns boolean
- Defined in packages/messages/src/browser/notifications-manager.ts:234

openLink

openLink(link): Promise<void>
Parameters
- link: string
Returns Promise<void>
- Defined in packages/messages/src/browser/notifications-manager.ts:304

reportProgress

reportProgress(messageId, update, originalMessage, cancellationToken): Promise<void>
Parameters
- messageId: string
- update: ProgressUpdate
- originalMessage: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<void>
Overrides MessageClient.reportProgress
- Defined in packages/messages/src/browser/notifications-manager.ts:284

`Protected` setVisibilityState

setVisibilityState(newState): void
Parameters
- newState: Visibility
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:111

showCenter

showCenter(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:123

showMessage

showMessage(plainMessage): Promise<undefined | string>
Parameters
- plainMessage: Message
Returns Promise<undefined | string>
Overrides MessageClient.showMessage
- Defined in packages/messages/src/browser/notifications-manager.ts:180

showProgress

showProgress(messageId, plainMessage, cancellationToken): Promise<undefined | string>
Parameters
- messageId: string
- plainMessage: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<undefined | string>
Overrides MessageClient.showProgress
- Defined in packages/messages/src/browser/notifications-manager.ts:256

`Protected` startHideTimeout

startHideTimeout(messageId, timeout): void
Parameters
- messageId: string
- timeout: number
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:212

`Protected` toNotificationType

toNotificationType(type?): messages.Type
Parameters
- Optional type: MessageType
Returns messages.Type
- Defined in packages/messages/src/browser/notifications-manager.ts:240

`Protected` toPlainProgress

toPlainProgress(update): undefined | number
Parameters
- update: ProgressUpdate
Returns undefined | number
- Defined in packages/messages/src/browser/notifications-manager.ts:300

toggleCenter

toggleCenter(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:126

toggleExpansion

toggleExpansion(notificationId): void
Parameters
- notificationId: string
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:171

`Protected` updateContextKeys

updateContextKeys(): void
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:98

Class NotificationManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NotificationManager

Properties

Protected Readonly contentRenderer

Protected Readonly contextKeyService

Protected Readonly deferredResults

Protected Readonly fireUpdatedEvent

Type declaration

Returns void

Protected hideTimeouts

Protected notificationCenterVisibleKey

Protected notificationToastsVisibleKey

Protected Readonly notifications

Protected notificationsVisible

Readonly onUpdated

Protected Readonly onUpdatedEmitter

Protected Readonly openerService

Protected Readonly preferences

Protected Readonly toasts

Protected visibilityState

Accessors

centerVisible

Returns boolean

toastsVisible

Returns boolean

Methods

accept

Parameters

Returns void

clear

Parameters

Returns void

clearAll

Returns void

Protected doInit

Returns Promise<void>

Protected find

Parameters

Returns undefined | Notification

Protected getId

Parameters

Returns string

Protected getMessageId

Parameters

Returns string

Protected getTimeout

Parameters

Returns number

hide

Returns void

hideCenter

Returns void

Protected hideToast

Parameters

Returns void

Protected init

Returns void

Protected isExpandable

Parameters

Returns boolean

openLink

Parameters

Returns Promise<void>

reportProgress

Parameters

Returns Promise<void>

Protected setVisibilityState

Parameters

Returns void

showCenter

Returns void

showMessage

`Protected` `Readonly` contentRenderer

`Protected` `Readonly` contextKeyService

`Protected` `Readonly` deferredResults

`Protected` `Readonly` fireUpdatedEvent

`Protected` hideTimeouts

`Protected` notificationCenterVisibleKey

`Protected` notificationToastsVisibleKey

`Protected` `Readonly` notifications

`Protected` notificationsVisible

`Readonly` onUpdated

`Protected` `Readonly` onUpdatedEmitter

`Protected` `Readonly` openerService

`Protected` `Readonly` preferences

`Protected` `Readonly` toasts

`Protected` visibilityState

`Protected` doInit

`Protected` find

`Protected` getId

`Protected` getMessageId

`Protected` getTimeout

`Protected` hideToast

`Protected` init

`Protected` isExpandable

`Protected` setVisibilityState

`Protected` startHideTimeout

`Protected` toNotificationType

`Protected` toPlainProgress

`Protected` updateContextKeys