Microsoft.Extensions.Options.xml
|
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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Extensions.Options</name> </assembly> <members> <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`1"> <summary> Implementation of IConfigureNamedOptions. </summary> <typeparam name="TOptions"></typeparam> </member> <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.#ctor(System.String,System.Action{`0})"> <summary> Constructor. </summary> <param name="name">The name of the options.</param> <param name="action">The action to register.</param> </member> <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Name"> <summary> The options name. </summary> </member> <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Action"> <summary> The configuration action. </summary> </member> <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Configure(System.String,`0)"> <summary> Invokes the registered configure Action if the name matches. </summary> <param name="name"></param> <param name="options"></param> </member> <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 if the name matches. </summary> <param name="options"></param> </member> <member name="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"> <summary> Represents something that configures the TOptions type. </summary> <typeparam name="TOptions"></typeparam> </member> <member name="M:Microsoft.Extensions.Options.IConfigureNamedOptions`1.Configure(System.String,`0)"> <summary> Invoked to configure a TOptions instance. </summary> <param name="name">The name of the options instance being configured.</param> <param name="options">The options instance to configure.</param> </member> <member name="T:Microsoft.Extensions.Options.IConfigureOptions`1"> <summary> Represents something that configures the TOptions type. Note: These are run before all <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>. </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 default configured TOptions instance, equivalent to Get(string.Empty). </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="P:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.Name"> <summary> The name of the option instance being changed. </summary> </member> <member name="T:Microsoft.Extensions.Options.IOptionsFactory`1"> <summary> Used to create TOptions instances. </summary> <typeparam name="TOptions">The type of options being requested.</typeparam> </member> <member name="M:Microsoft.Extensions.Options.IOptionsFactory`1.Create(System.String)"> <summary> Returns a configured TOptions instance with the given name. </summary> </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 with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>. </summary> </member> <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.Get(System.String)"> <summary> Returns a configured TOptions instance with the given name. </summary> </member> <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.OnChange(System.Action{`0,System.String})"> <summary> Registers a listener to be called whenever a named 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.IOptionsMonitorCache`1"> <summary> Used by <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1"/> to cache TOptions instances. </summary> <typeparam name="TOptions">The type of options being requested.</typeparam> </member> <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.GetOrAdd(System.String,System.Func{`0})"> <summary> Gets a named options instance, or adds a new instance created with createOptions. </summary> <param name="name">The name of the options instance.</param> <param name="createOptions">The func used to create the new instance.</param> <returns>The options instance.</returns> </member> <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.TryAdd(System.String,`0)"> <summary> Tries to adds a new option to the cache, will return false if the name already exists. </summary> <param name="name">The name of the options instance.</param> <param name="options">The options instance.</param> <returns>Whether anything was added.</returns> </member> <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.TryRemove(System.String)"> <summary> Try to remove an options instance. </summary> <param name="name">The name of the options instance.</param> <returns>Whether anything was removed.</returns> </member> <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.Clear"> <summary> Clears all options instances from the cache. </summary> </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="M:Microsoft.Extensions.Options.IOptionsSnapshot`1.Get(System.String)"> <summary> Returns a configured TOptions instance with the given name. </summary> </member> <member name="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"> <summary> Represents something that configures the TOptions type. Note: These are run after all <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>. </summary> <typeparam name="TOptions"></typeparam> </member> <member name="M:Microsoft.Extensions.Options.IPostConfigureOptions`1.PostConfigure(System.String,`0)"> <summary> Invoked to configure a TOptions instance. </summary> <param name="name">The name of the options instance being configured.</param> <param name="options">The options instance to configured.</param> </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.OptionsCache`1"> <summary> Used to cache TOptions instances. </summary> <typeparam name="TOptions">The type of options being requested.</typeparam> </member> <member name="M:Microsoft.Extensions.Options.OptionsCache`1.Clear"> <summary> Clears all options instances from the cache. </summary> </member> <member name="M:Microsoft.Extensions.Options.OptionsCache`1.GetOrAdd(System.String,System.Func{`0})"> <summary> Gets a named options instance, or adds a new instance created with createOptions. </summary> <param name="name">The name of the options instance.</param> <param name="createOptions">The func used to create the new instance.</param> <returns>The options instance.</returns> </member> <member name="M:Microsoft.Extensions.Options.OptionsCache`1.TryAdd(System.String,`0)"> <summary> Tries to adds a new option to the cache, will return false if the name already exists. </summary> <param name="name">The name of the options instance.</param> <param name="options">The options instance.</param> <returns>Whether anything was added.</returns> </member> <member name="M:Microsoft.Extensions.Options.OptionsCache`1.TryRemove(System.String)"> <summary> Try to remove an options instance. </summary> <param name="name">The name of the options instance.</param> <returns>Whether anything was removed.</returns> </member> <member name="T:Microsoft.Extensions.Options.OptionsFactory`1"> <summary> Implementation of IOptionsFactory. </summary> <typeparam name="TOptions">The type of options being requested.</typeparam> </member> <member name="M:Microsoft.Extensions.Options.OptionsFactory`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IPostConfigureOptions{`0}})"> <summary> Initializes a new instance with the specified options configurations. </summary> <param name="setups">The configuration actions to run.</param> <param name="postConfigures">The initialization actions to run.</param> </member> <member name="T:Microsoft.Extensions.Options.OptionsManager`1"> <summary> Implementation of IOptions and IOptionsSnapshot. </summary> <typeparam name="TOptions"></typeparam> </member> <member name="M:Microsoft.Extensions.Options.OptionsManager`1.#ctor(Microsoft.Extensions.Options.IOptionsFactory{`0})"> <summary> Initializes a new instance with the specified options configurations. </summary> <param name="factory">The factory to use to create options.</param> </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(Microsoft.Extensions.Options.IOptionsFactory{`0},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IOptionsChangeTokenSource{`0}},Microsoft.Extensions.Options.IOptionsMonitorCache{`0})"> <summary> Constructor. </summary> <param name="factory">The factory to use to create options.</param> <param name="sources">The sources used to listen for changes to the options instance.</param> <param name="cache">The cache used to store options.</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,System.String})"> <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.OptionsMonitorExtensions"> <summary> Extension methods for IOptionsMonitor. </summary> </member> <member name="M:Microsoft.Extensions.Options.OptionsMonitorExtensions.OnChange``1(Microsoft.Extensions.Options.IOptionsMonitor{``0},System.Action{``0})"> <summary> Registers a listener to be called whenever TOptions changes. </summary> <param name="monitor">The IOptionsMonitor.</param> <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.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="T:Microsoft.Extensions.Options.PostConfigureOptions`1"> <summary> Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>. </summary> <typeparam name="TOptions"></typeparam> </member> <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`1.#ctor(System.String,System.Action{`0})"> <summary> Creates a new instance of <see cref="T:Microsoft.Extensions.Options.PostConfigureOptions`1"/>. </summary> <param name="name">The name of the options.</param> <param name="action">The action to register.</param> </member> <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Name"> <summary> The options name. </summary> </member> <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Action"> <summary> The initialization action. </summary> </member> <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`1.PostConfigure(System.String,`0)"> <summary> Invokes the registered initialization Action if the name matches. </summary> <param name="name"></param> <param name="options"></param> </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. Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>. </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> <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{``0})"> <summary> Registers an action used to configure a particular type of options. Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>. </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="name">The name of the options instance.</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> <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureAll``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"> <summary> Registers an action used to configure all instances of 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> <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"> <summary> Registers an action used to initialize a particular type of options. Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>. </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> <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{``0})"> <summary> Registers an action used to configure a particular type of options. Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>. </summary> <typeparam name="TOptions">The options type to be configure.</typeparam> <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param> <param name="name">The name of the options instance.</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> <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigureAll``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"> <summary> Registers an action used to post configure all instances of a particular type of options. Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>. </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> |