-
Notifications
You must be signed in to change notification settings - Fork 10
/
WidgetMetadata.yml
317 lines (317 loc) · 10.1 KB
/
WidgetMetadata.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
### YamlMime:TSType
name: WidgetMetadata
uid: azure-devops-extension-api.WidgetMetadata
package: azure-devops-extension-api
summary: Contribution based information describing Dashboard Widgets.
fullName: WidgetMetadata
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allowedSizes
uid: azure-devops-extension-api.WidgetMetadata.allowedSizes
package: azure-devops-extension-api
summary: Sizes supported by the Widget.
fullName: allowedSizes
remarks: ''
isDeprecated: false
syntax:
content: 'allowedSizes: WidgetSize[]'
return:
description: ''
type: <xref uid="azure-devops-extension-api.WidgetSize" />[]
- name: analyticsServiceRequired
uid: azure-devops-extension-api.WidgetMetadata.analyticsServiceRequired
package: azure-devops-extension-api
summary: >-
Opt-in boolean that indicates if the widget requires the Analytics Service
to function. Widgets requiring the analytics service are hidden from the
catalog if the Analytics Service is not available.
fullName: analyticsServiceRequired
remarks: ''
isDeprecated: false
syntax:
content: 'analyticsServiceRequired: boolean'
return:
description: ''
type: boolean
- name: catalogIconUrl
uid: azure-devops-extension-api.WidgetMetadata.catalogIconUrl
package: azure-devops-extension-api
summary: Resource for an icon in the widget catalog.
fullName: catalogIconUrl
remarks: ''
isDeprecated: false
syntax:
content: 'catalogIconUrl: string'
return:
description: ''
type: string
- name: catalogInfoUrl
uid: azure-devops-extension-api.WidgetMetadata.catalogInfoUrl
package: azure-devops-extension-api
summary: >-
Opt-in URL string pointing at widget information. Defaults to extension
marketplace URL if omitted
fullName: catalogInfoUrl
remarks: ''
isDeprecated: false
syntax:
content: 'catalogInfoUrl: string'
return:
description: ''
type: string
- name: configurationContributionId
uid: azure-devops-extension-api.WidgetMetadata.configurationContributionId
package: azure-devops-extension-api
summary: >-
The id of the underlying contribution defining the supplied Widget custom
configuration UI. Null if custom configuration UI is not available.
fullName: configurationContributionId
remarks: ''
isDeprecated: false
syntax:
content: 'configurationContributionId: string'
return:
description: ''
type: string
- name: configurationContributionRelativeId
uid: >-
azure-devops-extension-api.WidgetMetadata.configurationContributionRelativeId
package: azure-devops-extension-api
summary: >-
The relative id of the underlying contribution defining the supplied
Widget custom configuration UI. Null if custom configuration UI is not
available.
fullName: configurationContributionRelativeId
remarks: ''
isDeprecated: false
syntax:
content: 'configurationContributionRelativeId: string'
return:
description: ''
type: string
- name: configurationRequired
uid: azure-devops-extension-api.WidgetMetadata.configurationRequired
package: azure-devops-extension-api
summary: >-
Indicates if the widget requires configuration before being added to
dashboard.
fullName: configurationRequired
remarks: ''
isDeprecated: false
syntax:
content: 'configurationRequired: boolean'
return:
description: ''
type: boolean
- name: contentUri
uid: azure-devops-extension-api.WidgetMetadata.contentUri
package: azure-devops-extension-api
summary: Uri for the widget content to be loaded from .
fullName: contentUri
remarks: ''
isDeprecated: false
syntax:
content: 'contentUri: string'
return:
description: ''
type: string
- name: contributionId
uid: azure-devops-extension-api.WidgetMetadata.contributionId
package: azure-devops-extension-api
summary: The id of the underlying contribution defining the supplied Widget.
fullName: contributionId
remarks: ''
isDeprecated: false
syntax:
content: 'contributionId: string'
return:
description: ''
type: string
- name: defaultSettings
uid: azure-devops-extension-api.WidgetMetadata.defaultSettings
package: azure-devops-extension-api
summary: Optional default settings to be copied into widget settings.
fullName: defaultSettings
remarks: ''
isDeprecated: false
syntax:
content: 'defaultSettings: string'
return:
description: ''
type: string
- name: description
uid: azure-devops-extension-api.WidgetMetadata.description
package: azure-devops-extension-api
summary: Summary information describing the widget.
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description: string'
return:
description: ''
type: string
- name: isEnabled
uid: azure-devops-extension-api.WidgetMetadata.isEnabled
package: azure-devops-extension-api
summary: >-
Widgets can be disabled by the app store. We'll need to gracefully handle
for: - persistence (Allow) - Requests (Tag as disabled, and provide
context)
fullName: isEnabled
remarks: ''
isDeprecated: false
syntax:
content: 'isEnabled: boolean'
return:
description: ''
type: boolean
- name: isNameConfigurable
uid: azure-devops-extension-api.WidgetMetadata.isNameConfigurable
package: azure-devops-extension-api
summary: >-
Opt-out boolean that indicates if the widget supports widget name/title
configuration. Widgets ignoring the name should set it to false in the
manifest.
fullName: isNameConfigurable
remarks: ''
isDeprecated: false
syntax:
content: 'isNameConfigurable: boolean'
return:
description: ''
type: boolean
- name: isVisibleFromCatalog
uid: azure-devops-extension-api.WidgetMetadata.isVisibleFromCatalog
package: azure-devops-extension-api
summary: >-
Opt-out boolean indicating if the widget is hidden from the catalog.
Commonly, this is used to allow developers to disable creation of a
deprecated widget. A widget must have a functional default state, or have
a configuration experience, in order to be visible from the catalog.
fullName: isVisibleFromCatalog
remarks: ''
isDeprecated: false
syntax:
content: 'isVisibleFromCatalog: boolean'
return:
description: ''
type: boolean
- name: keywords
uid: azure-devops-extension-api.WidgetMetadata.keywords
package: azure-devops-extension-api
summary: Keywords associated with this widget, non-filterable and invisible
fullName: keywords
remarks: ''
isDeprecated: false
syntax:
content: 'keywords: string[]'
return:
description: ''
type: string[]
- name: lightboxOptions
uid: azure-devops-extension-api.WidgetMetadata.lightboxOptions
package: azure-devops-extension-api
summary: >-
Opt-in properties for customizing widget presentation in a "lightbox"
dialog.
fullName: lightboxOptions
remarks: ''
isDeprecated: false
syntax:
content: 'lightboxOptions: LightboxOptions'
return:
description: ''
type: <xref uid="azure-devops-extension-api.LightboxOptions" />
- name: loadingImageUrl
uid: azure-devops-extension-api.WidgetMetadata.loadingImageUrl
package: azure-devops-extension-api
summary: Resource for a loading placeholder image on dashboard
fullName: loadingImageUrl
remarks: ''
isDeprecated: false
syntax:
content: 'loadingImageUrl: string'
return:
description: ''
type: string
- name: name
uid: azure-devops-extension-api.WidgetMetadata.name
package: azure-devops-extension-api
summary: >-
User facing name of the widget type. Each widget must use a unique value
here.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: publisherName
uid: azure-devops-extension-api.WidgetMetadata.publisherName
package: azure-devops-extension-api
summary: Publisher Name of this kind of widget.
fullName: publisherName
remarks: ''
isDeprecated: false
syntax:
content: 'publisherName: string'
return:
description: ''
type: string
- name: supportedScopes
uid: azure-devops-extension-api.WidgetMetadata.supportedScopes
package: azure-devops-extension-api
summary: >-
Data contract required for the widget to function and to work in its
container.
fullName: supportedScopes
remarks: ''
isDeprecated: false
syntax:
content: 'supportedScopes: WidgetScope[]'
return:
description: ''
type: <xref uid="azure-devops-extension-api.WidgetScope" />[]
- name: tags
uid: azure-devops-extension-api.WidgetMetadata.tags
package: azure-devops-extension-api
summary: Tags associated with this widget, visible on each widget and filterable.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags: string[]'
return:
description: ''
type: string[]
- name: targets
uid: azure-devops-extension-api.WidgetMetadata.targets
package: azure-devops-extension-api
summary: Contribution target IDs
fullName: targets
remarks: ''
isDeprecated: false
syntax:
content: 'targets: string[]'
return:
description: ''
type: string[]
- name: typeId
uid: azure-devops-extension-api.WidgetMetadata.typeId
package: azure-devops-extension-api
summary: >-
Deprecated: locally unique developer-facing id of this kind of widget.
ContributionId provides a globally unique identifier for widget types.
fullName: typeId
remarks: ''
isDeprecated: false
syntax:
content: 'typeId: string'
return:
description: ''
type: string