/
ContributedFeature.yml
184 lines (184 loc) · 5.84 KB
/
ContributedFeature.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
### YamlMime:TSType
name: ContributedFeature
uid: azure-devops-extension-api.ContributedFeature
package: azure-devops-extension-api
summary: A feature that can be enabled or disabled
fullName: ContributedFeature
remarks: ''
isDeprecated: false
type: interface
properties:
- name: defaultState
uid: azure-devops-extension-api.ContributedFeature.defaultState
package: azure-devops-extension-api
summary: If true, the feature is enabled unless overridden at some scope
fullName: defaultState
remarks: ''
isDeprecated: false
syntax:
content: 'defaultState: boolean'
return:
description: ''
type: boolean
- name: defaultValueRules
uid: azure-devops-extension-api.ContributedFeature.defaultValueRules
package: azure-devops-extension-api
summary: >-
Rules for setting the default value if not specified by any setting/scope.
Evaluated in order until a rule returns an Enabled or Disabled state (not
Undefined)
fullName: defaultValueRules
remarks: ''
isDeprecated: false
syntax:
content: 'defaultValueRules: ContributedFeatureValueRule[]'
return:
description: ''
type: >-
<xref uid="azure-devops-extension-api.ContributedFeatureValueRule"
/>[]
- name: description
uid: azure-devops-extension-api.ContributedFeature.description
package: azure-devops-extension-api
summary: The description of the feature
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description: string'
return:
description: ''
type: string
- name: featureProperties
uid: azure-devops-extension-api.ContributedFeature.featureProperties
package: azure-devops-extension-api
summary: Extra properties for the feature
fullName: featureProperties
remarks: ''
isDeprecated: false
syntax:
content: 'featureProperties: {[key: string]: any}'
return:
description: ''
type: '{[key: string]: any}'
- name: featureStateChangedListeners
uid: azure-devops-extension-api.ContributedFeature.featureStateChangedListeners
package: azure-devops-extension-api
summary: >-
Handler for listening to setter calls on feature value. These listeners
are only invoked after a successful set has occurred
fullName: featureStateChangedListeners
remarks: ''
isDeprecated: false
syntax:
content: 'featureStateChangedListeners: ContributedFeatureListener[]'
return:
description: ''
type: <xref uid="azure-devops-extension-api.ContributedFeatureListener" />[]
- name: id
uid: azure-devops-extension-api.ContributedFeature.id
package: azure-devops-extension-api
summary: The full contribution id of the feature
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id: string'
return:
description: ''
type: string
- name: includeAsClaim
uid: azure-devops-extension-api.ContributedFeature.includeAsClaim
package: azure-devops-extension-api
summary: >-
If this is set to true, then the id for this feature will be added to the
list of claims for the request.
fullName: includeAsClaim
remarks: ''
isDeprecated: false
syntax:
content: 'includeAsClaim: boolean'
return:
description: ''
type: boolean
- name: name
uid: azure-devops-extension-api.ContributedFeature.name
package: azure-devops-extension-api
summary: The friendly name of the feature
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: order
uid: azure-devops-extension-api.ContributedFeature.order
package: azure-devops-extension-api
summary: Suggested order to display feature in.
fullName: order
remarks: ''
isDeprecated: false
syntax:
content: 'order: number'
return:
description: ''
type: number
- name: overrideRules
uid: azure-devops-extension-api.ContributedFeature.overrideRules
package: azure-devops-extension-api
summary: >-
Rules for overriding a feature value. These rules are run before explicit
user/host state values are checked. They are evaluated in order until a
rule returns an Enabled or Disabled state (not Undefined)
fullName: overrideRules
remarks: ''
isDeprecated: false
syntax:
content: 'overrideRules: ContributedFeatureValueRule[]'
return:
description: ''
type: >-
<xref uid="azure-devops-extension-api.ContributedFeatureValueRule"
/>[]
- name: scopes
uid: azure-devops-extension-api.ContributedFeature.scopes
package: azure-devops-extension-api
summary: >-
The scopes/levels at which settings can set the enabled/disabled state of
this feature
fullName: scopes
remarks: ''
isDeprecated: false
syntax:
content: 'scopes: ContributedFeatureSettingScope[]'
return:
description: ''
type: >-
<xref uid="azure-devops-extension-api.ContributedFeatureSettingScope"
/>[]
- name: serviceInstanceType
uid: azure-devops-extension-api.ContributedFeature.serviceInstanceType
package: azure-devops-extension-api
summary: The service instance id of the service that owns this feature
fullName: serviceInstanceType
remarks: ''
isDeprecated: false
syntax:
content: 'serviceInstanceType: string'
return:
description: ''
type: string
- name: tags
uid: azure-devops-extension-api.ContributedFeature.tags
package: azure-devops-extension-api
summary: Tags associated with the feature.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags: string[]'
return:
description: ''
type: string[]