Microsoft.Extensions.Options.xml
11.6 KB
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Extensions.Options</name>
</assembly>
<members>
<member name="T:Microsoft.Extensions.Options.ConfigureOptions`1">
<summary>
Implementation of IConfigureOptions.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.#ctor(System.Action{`0})">
<summary>
Constructor.
</summary>
<param name="action">The action to register.</param>
</member>
<member name="P:Microsoft.Extensions.Options.ConfigureOptions`1.Action">
<summary>
The configuration action.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.Configure(`0)">
<summary>
Invokes the registered configure Action.
</summary>
<param name="options"></param>
</member>
<member name="T:Microsoft.Extensions.Options.IConfigureOptions`1">
<summary>
Represents something that configures the TOptions type.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.IConfigureOptions`1.Configure(`0)">
<summary>
Invoked to configure a TOptions instance.
</summary>
<param name="options">The options instance to configure.</param>
</member>
<member name="T:Microsoft.Extensions.Options.IOptions`1">
<summary>
Used to retreive configured TOptions instances.
</summary>
<typeparam name="TOptions">The type of options being requested.</typeparam>
</member>
<member name="P:Microsoft.Extensions.Options.IOptions`1.Value">
<summary>
The configured TOptions instance.
</summary>
</member>
<member name="T:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1">
<summary>
Used to fetch IChangeTokens used for tracking options changes.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.GetChangeToken">
<summary>
Returns a IChangeToken which can be used to register a change notification callback.
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.Extensions.Options.IOptionsMonitor`1">
<summary>
Used for notifications when TOptions instances change.
</summary>
<typeparam name="TOptions">The options type.</typeparam>
</member>
<member name="P:Microsoft.Extensions.Options.IOptionsMonitor`1.CurrentValue">
<summary>
Returns the current TOptions instance.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.OnChange(System.Action{`0})">
<summary>
Registers a listener to be called whenever TOptions changes.
</summary>
<param name="listener">The action to be invoked when TOptions has changed.</param>
<returns>An IDisposable which should be disposed to stop listening for changes.</returns>
</member>
<member name="T:Microsoft.Extensions.Options.IOptionsSnapshot`1">
<summary>
Used to access the value of TOptions for the lifetime of a request.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="P:Microsoft.Extensions.Options.IOptionsSnapshot`1.Value">
<summary>
Returns the value of the TOptions which will be computed once
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.Extensions.Options.Options">
<summary>
Helper class.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.Options.Create``1(``0)">
<summary>
Creates a wrapper around an instance of TOptions to return itself as an IOptions.
</summary>
<typeparam name="TOptions"></typeparam>
<param name="options"></param>
<returns></returns>
</member>
<member name="T:Microsoft.Extensions.Options.OptionsManager`1">
<summary>
Implementation of IOptions.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.OptionsManager`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}})">
<summary>
Initializes a new instance with the specified options configurations.
</summary>
<param name="setups">The configuration actions to run.</param>
</member>
<member name="P:Microsoft.Extensions.Options.OptionsManager`1.Value">
<summary>
The configured options instance.
</summary>
</member>
<member name="T:Microsoft.Extensions.Options.OptionsMonitor`1">
<summary>
Implementation of IOptionsMonitor.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IOptionsChangeTokenSource{`0}})">
<summary>
Constructor.
</summary>
<param name="setups">The configuration actions to run on an options instance.</param>
<param name="sources">The sources used to listen for changes to the options instance.</param>
</member>
<member name="P:Microsoft.Extensions.Options.OptionsMonitor`1.CurrentValue">
<summary>
The present value of the options.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.OnChange(System.Action{`0})">
<summary>
Registers a listener to be called whenever TOptions changes.
</summary>
<param name="listener">The action to be invoked when TOptions has changed.</param>
<returns>An IDisposable which should be disposed to stop listening for changes.</returns>
</member>
<member name="T:Microsoft.Extensions.Options.OptionsSnapshot`1">
<summary>
Implementation of IOptionsSnapshot.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.OptionsSnapshot`1.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{`0})">
<summary>
Initializes a new instance.
</summary>
<param name="monitor">The monitor to fetch the options value from.</param>
</member>
<member name="P:Microsoft.Extensions.Options.OptionsSnapshot`1.Value">
<summary>
The configured options instance.
</summary>
</member>
<member name="T:Microsoft.Extensions.Options.OptionsWrapper`1">
<summary>
IOptions wrapper that returns the options instance.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.#ctor(`0)">
<summary>
Intializes the wrapper with the options instance to return.
</summary>
<param name="options">The options instance to return.</param>
</member>
<member name="P:Microsoft.Extensions.Options.OptionsWrapper`1.Value">
<summary>
The options instance.
</summary>
</member>
<member name="P:Microsoft.Extensions.Options.Resources.Error_CannotActivateAbstractOrInterface">
<summary>
Cannot create instance of type '{0}' because it is either abstract or an interface.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.Resources.FormatError_CannotActivateAbstractOrInterface(System.Object)">
<summary>
Cannot create instance of type '{0}' because it is either abstract or an interface.
</summary>
</member>
<member name="P:Microsoft.Extensions.Options.Resources.Error_FailedBinding">
<summary>
Failed to convert '{0}' to type '{1}'.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.Resources.FormatError_FailedBinding(System.Object,System.Object)">
<summary>
Failed to convert '{0}' to type '{1}'.
</summary>
</member>
<member name="P:Microsoft.Extensions.Options.Resources.Error_FailedToActivate">
<summary>
Failed to create instance of type '{0}'.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.Resources.FormatError_FailedToActivate(System.Object)">
<summary>
Failed to create instance of type '{0}'.
</summary>
</member>
<member name="P:Microsoft.Extensions.Options.Resources.Error_MissingParameterlessConstructor">
<summary>
Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.Resources.FormatError_MissingParameterlessConstructor(System.Object)">
<summary>
Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
</summary>
</member>
<member name="T:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions">
<summary>
Extension methods for adding options services to the DI container.
</summary>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
Adds services required for using options.
</summary>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
<summary>
Registers an action used to configure a particular type of options.
</summary>
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
<param name="configureOptions">The action used to configure the options.</param>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
</member>
</members>
</doc>