1
>
/*---------------------------------------------------------------------------------------------
notification.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { localize } from '../../../nls.js';
7
>
import { IAction } from '../../../base/common/actions.js';
8
>
import { Event } from '../../../base/common/event.js';
9
>
import BaseSeverity from '../../../base/common/severity.js';
10
>
import { createDecorator } from '../../instantiation/common/instantiation.js';
11
>
12
>
export import Severity = BaseSeverity;
13
>
14
>
export const INotificationService = createDecorator<INotificationService>('notificationService');
15
>
16
>
export type NotificationMessage = string | Error;
17
>
18
>
export enum NotificationPriority {
19
>
20
>
/**
21
>
* Default priority: notification will be visible unless do not disturb mode is enabled.
22
>
*/
23
>
DEFAULT,
24
>
25
>
/**
26
>
* Optional priority: notification might only be visible from the notifications center.
27
>
*/
28
>
OPTIONAL,
29
>
30
>
/**
31
>
* Silent priority: notification will only be visible from the notifications center.
32
>
*/
33
>
SILENT,
34
>
35
>
/**
36
>
* Urgent priority: notification will be visible even when do not disturb mode is enabled.
37
>
*/
38
>
URGENT
39
>
}
40
>
41
>
export interface INotificationProperties {
42
>
43
>
/**
44
>
* Sticky notifications are not automatically removed after a certain timeout.
45
>
*
46
>
* Currently, only 2 kinds of notifications are sticky:
47
>
* - Error notifications with primary actions
48
>
* - Notifications that show progress
49
>
*/
50
>
readonly sticky?: boolean;
51
>
52
>
/**
53
>
* Allows to override the priority of the notification based on needs.
54
>
*/
55
>
readonly priority?: NotificationPriority;
56
>
57
>
/**
58
>
* Adds an action to never show the notification again. The choice will be persisted
59
>
* such as future requests will not cause the notification to show again.
60
>
*/
61
>
readonly neverShowAgain?: INeverShowAgainOptions;
62
>
}
63
>
64
>
export enum NeverShowAgainScope {
65
>
66
>
/**
67
>
* Will never show this notification on the current workspace again.
68
>
*/
69
>
WORKSPACE,
70
>
71
>
/**
72
>
* Will never show this notification on any workspace of the same
73
>
* profile again.
74
>
*/
75
>
PROFILE,
76
>
77
>
/**
78
>
* Will never show this notification on any workspace across all
79
>
* profiles again.
80
>
*/
81
>
APPLICATION
82
>
}
83
>
84
>
export interface INeverShowAgainOptions {
85
>
86
>
/**
87
>
* The id is used to persist the selection of not showing the notification again.
88
>
*/
89
>
readonly id: string;
90
>
91
>
/**
92
>
* By default the action will show up as primary action. Setting this to true will
93
>
* make it a secondary action instead.
94
>
*/
95
>
readonly isSecondary?: boolean;
96
>
97
>
/**
98
>
* Whether to persist the choice in the current workspace or for all workspaces. By
99
>
* default it will be persisted for all workspaces across all profiles
100
>
* (= `NeverShowAgainScope.APPLICATION`).
101
>
*/
102
>
readonly scope?: NeverShowAgainScope;
103
>
}
104
>
105
>
export interface INotificationSource {
106
>
107
>
/**
108
>
* The id of the source.
109
>
*/
110
>
readonly id: string;
111
>
112
>
/**
113
>
* The label of the source.
114
>
*/
115
>
readonly label: string;
116
>
}
117
>
118
>
export function isNotificationSource(thing: unknown): thing is INotificationSource {
119
if (thing) {
120
const candidate = thing as INotificationSource;