Files
git.stella-ops.org/local-nuget/microsoft.extensions.options.configurationextensions/10.0.0-rc.2.25502.107/lib/net8.0/Microsoft.Extensions.Options.ConfigurationExtensions.xml
2025-11-17 20:46:40 +02:00

157 lines
13 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Extensions.Options.ConfigurationExtensions</name>
</assembly>
<members>
<member name="T:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1">
<summary>
Creates <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>s so that <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1"/> gets
notified when <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> changes.
</summary>
<typeparam name="TOptions"></typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Constructor taking the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to watch.
</summary>
<param name="config">The configuration instance.</param>
</member>
<member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Constructor taking the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to watch.
</summary>
<param name="name">The name of the options instance being watched.</param>
<param name="config">The configuration instance.</param>
</member>
<member name="P:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.Name">
<summary>
The name of the option instance being changed.
</summary>
</member>
<member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.GetChangeToken">
<summary>
Returns the reloadToken from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1">
<summary>
Configures an option instance by using <see cref="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)"/> against an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
</summary>
<typeparam name="TOptions">The type of options to bind.</typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1"/> class using the specified <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to bind against.
</summary>
<param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance.</param>
</member>
<member name="T:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1">
<summary>
Configures an option instance by using <see cref="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)"/> against an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
</summary>
<typeparam name="TOptions">The type of options to bind.</typeparam>
</member>
<member name="M:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Constructor that takes the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to bind against.
</summary>
<param name="name">The name of the options instance.</param>
<param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance.</param>
</member>
<member name="M:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
<summary>
Constructor that takes the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to bind against.
</summary>
<param name="name">The name of the options instance.</param>
<param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance.</param>
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
</member>
<member name="T:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions">
<summary>
Extension methods for adding configuration related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Registers a configuration instance which <typeparamref name="TOptions"/> will bind against.
</summary>
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="optionsBuilder">The options builder to add the services to.</param>
<param name="config">The configuration being bound.</param>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
<summary>
Registers a configuration instance which <typeparamref name="TOptions"/> will bind against.
</summary>
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="optionsBuilder">The options builder to add the services to.</param>
<param name="config">The configuration being bound.</param>
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.BindConfiguration``1(Microsoft.Extensions.Options.OptionsBuilder{``0},System.String,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
<summary>
Registers the dependency injection container to bind <typeparamref name="TOptions"/> against
the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> obtained from the DI service provider.
</summary>
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="optionsBuilder">The options builder to add the services to.</param>
<param name="configSectionPath">The name of the configuration section to bind from.</param>
<param name="configureBinder">Optional. Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="optionsBuilder"/> or <paramref name="configSectionPath" /> is <see langword="null"/>.
</exception>
<seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})"/>
</member>
<member name="T:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions">
<summary>
Extension methods for adding configuration-related options services to the DI container.
</summary>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Registers a configuration instance that <typeparamref name="TOptions" /> will bind against.
</summary>
<typeparam name="TOptions">The type of options being configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
<param name="config">The configuration being bound.</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.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Registers a configuration instance that <typeparamref name="TOptions" /> will bind against.
</summary>
<typeparam name="TOptions">The type of options being 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="config">The configuration being bound.</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.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
<summary>
Registers a configuration instance that <typeparamref name="TOptions" /> will bind against.
</summary>
<typeparam name="TOptions">The type of options being configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
<param name="config">The configuration being bound.</param>
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</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.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
<summary>
Registers a configuration instance that <typeparamref name="TOptions" /> will bind against.
</summary>
<typeparam name="TOptions">The type of options being 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="config">The configuration being bound.</param>
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
</member>
</members>
</doc>