Class NotificationManager

Hierarchy (View Summary)

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> = ...

`Protected`hideTimeouts

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

`Protected`notificationCenterVisibleKey

notificationCenterVisibleKey: ContextKey<boolean>

`Protected` `Readonly`notifications

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

`Protected`notificationsVisible

notificationsVisible: ContextKey<boolean>

`Protected`notificationToastsVisibleKey

notificationToastsVisibleKey: 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: string | Notification, action: undefined | string): void
Parameters
- notification: string | Notification
- action: undefined | string
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:130

clear

clear(notification: string | 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: string | 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 | Notification): string
Parameters
- notification: string | Notification
Returns string
- Defined in packages/messages/src/browser/notifications-manager.ts:151

`Protected`getMessageId

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

`Protected`getTimeout

getTimeout(plainMessage: Message): 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: string): 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: string,
    source: undefined | string,
    actions: string[],
): boolean
Parameters
- message: string
- source: undefined | string
- actions: string[]
Returns boolean
- Defined in packages/messages/src/browser/notifications-manager.ts:234

openLink

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

reportProgress

reportProgress(
    messageId: string,
    update: ProgressUpdate,
    originalMessage: ProgressMessage,
    cancellationToken: CancellationToken,
): Promise<void>
Update a previously created progress message.

To be implemented by an extension, e.g. by the messages extension.
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: Visibility): 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: Message): Promise<undefined | string>
Show a message of the given type and possible actions to the user. Resolve to a chosen action. Never reject.

To be implemented by an extension, e.g. by the messages extension.
Parameters
- plainMessage: Message
Returns Promise<undefined | string>
Overrides MessageClient.showMessage
- Defined in packages/messages/src/browser/notifications-manager.ts:180

showProgress

showProgress(
    messageId: string,
    plainMessage: ProgressMessage,
    cancellationToken: CancellationToken,
): Promise<undefined | string>
Show a progress message with possible actions to user.

To be implemented by an extension, e.g. by the messages extension.
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: string, timeout: number): void
Parameters
- messageId: string
- timeout: number
Returns void
- Defined in packages/messages/src/browser/notifications-manager.ts:212

toggleCenter

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

toggleExpansion

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

`Protected`toNotificationType

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

`Protected`toPlainProgress

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

`Protected`updateContextKeys

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