2097 lines
123 KiB
XML
2097 lines
123 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Microsoft.Extensions.Options</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</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 <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`2">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep">Dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.#ctor(System.String,`1,System.Action{`0,`1})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency">A dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Dependency">
|
|
<summary>
|
|
The dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Configure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`3">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.#ctor(System.String,`1,`2,System.Action{`0,`1,`2})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Configure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`4">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.#ctor(System.String,`1,`2,`3,System.Action{`0,`1,`2,`3})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="dependency3">A third dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Configure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`5">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
<typeparam name="TDep4">Fourth dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Action{`0,`1,`2,`3,`4})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency1">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="dependency3">A third dependency.</param>
|
|
<param name="dependency4">A fourth dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency4">
|
|
<summary>
|
|
The fourth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Configure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`6">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
<typeparam name="TDep4">Fourth dependency type.</typeparam>
|
|
<typeparam name="TDep5">Fifth dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Action{`0,`1,`2,`3,`4,`5})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency1">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="dependency3">A third dependency.</param>
|
|
<param name="dependency4">A fourth dependency.</param>
|
|
<param name="dependency5">A fifth dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency4">
|
|
<summary>
|
|
The fourth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency5">
|
|
<summary>
|
|
The fifth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Configure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ConfigureOptions`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</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 <see cref="P:Microsoft.Extensions.Options.ConfigureOptions`1.Action"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1">
|
|
<summary>
|
|
Represents something that configures the <typeparamref name="TOptions"/> type.
|
|
</summary>
|
|
<typeparam name="TOptions">The options type being configured.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IConfigureNamedOptions`1.Configure(System.String,`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="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 <typeparamref name="TOptions"/> type.
|
|
Note: These are run before all <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">The options type being configured.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IConfigureOptions`1.Configure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance.
|
|
</summary>
|
|
<param name="options">The options instance to configure.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.IOptions`1">
|
|
<summary>
|
|
Used to retrieve configured <typeparamref name="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 <typeparamref name="TOptions"/> instance
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1">
|
|
<summary>
|
|
Used to fetch <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> used for tracking options changes.
|
|
</summary>
|
|
<typeparam name="TOptions">The options type being changed.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.GetChangeToken">
|
|
<summary>
|
|
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> which can be used to register a change notification callback.
|
|
</summary>
|
|
<returns>Change token.</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 <typeparamref name="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 <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance to create.</param>
|
|
<returns>The created <typeparamref name="TOptions"/> instance with thw given <paramref name="name"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.IOptionsMonitor`1">
|
|
<summary>
|
|
Used for notifications when <typeparamref name="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 <typeparamref name="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 <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance, if a <see langword="null"/> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> is used.</param>
|
|
<returns>The <typeparamref name="TOptions"/> instance that matches the given <paramref name="name"/>.</returns>
|
|
</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 <typeparamref name="TOptions"/> changes.
|
|
</summary>
|
|
<param name="listener">The action to be invoked when <typeparamref name="TOptions"/> has changed.</param>
|
|
<returns>An <see cref="T:System.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 <typeparamref name="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 <paramref name="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 <typeparamref name="TOptions"/> for the lifetime of a request.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IOptionsSnapshot`1.Get(System.String)">
|
|
<summary>
|
|
Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance, if <see langword="null"/> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> is used.</param>
|
|
<returns>The <typeparamref name="TOptions"/> instance that matches the given <paramref name="name"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.IPostConfigureOptions`1">
|
|
<summary>
|
|
Represents something that configures the <typeparamref name="TOptions"/> type.
|
|
Note: These are run after all <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IPostConfigureOptions`1.PostConfigure(System.String,`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="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.IStartupValidator">
|
|
<summary>
|
|
Interface used by hosts to validate options during startup.
|
|
Options are enabled to be validated during startup by calling <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions.ValidateOnStart``1(Microsoft.Extensions.Options.OptionsBuilder{``0})"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IStartupValidator.Validate">
|
|
<summary>
|
|
Calls the <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> validators.
|
|
</summary>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating.</exception>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.IValidateOptions`1">
|
|
<summary>
|
|
Interface used to validate options.
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.IValidateOptions`1.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when name is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.Options">
|
|
<summary>
|
|
Helper class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.Extensions.Options.Options.DefaultName">
|
|
<summary>
|
|
The default name used for options instances: "".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.Options.Create``1(``0)">
|
|
<summary>
|
|
Creates a wrapper around an instance of <typeparamref name="TOptions"/> to return itself as an <see cref="T:Microsoft.Extensions.Options.IOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type.</typeparam>
|
|
<param name="options">Options object.</param>
|
|
<returns>Wrapped options object.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsBuilder`1">
|
|
<summary>
|
|
Used to configure <typeparamref name="TOptions"/> instances.
|
|
</summary>
|
|
<typeparam name="TOptions">The type of options being requested.</typeparam>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.OptionsBuilder`1.Name">
|
|
<summary>
|
|
The default name of the <typeparamref name="TOptions"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.OptionsBuilder`1.Services">
|
|
<summary>
|
|
The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for the options being configured.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.#ctor(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for the options being configured.</param>
|
|
<param name="name">The default name of the <typeparamref name="TOptions"/> instance, if null <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> is used.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(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.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
|
|
</summary>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``1(System.Action{`0,``0})">
|
|
<summary>
|
|
Registers an action used to configure a particular type of options.
|
|
Note: These are run before all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep">A dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``2(System.Action{`0,``0,``1})">
|
|
<summary>
|
|
Registers an action used to configure a particular type of options.
|
|
Note: These are run before all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``3(System.Action{`0,``0,``1,``2})">
|
|
<summary>
|
|
Registers an action used to configure a particular type of options.
|
|
Note: These are run before all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``4(System.Action{`0,``0,``1,``2,``3})">
|
|
<summary>
|
|
Registers an action used to configure a particular type of options.
|
|
Note: These are run before all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the action.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``5(System.Action{`0,``0,``1,``2,``3,``4})">
|
|
<summary>
|
|
Registers an action used to configure a particular type of options.
|
|
Note: These are run before all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the action.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
|
|
<typeparam name="TDep5">The fifth dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(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.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
|
|
</summary>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``1(System.Action{`0,``0})">
|
|
<summary>
|
|
Registers an action used to post configure a particular type of options.
|
|
Note: These are run after all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep">The dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``2(System.Action{`0,``0,``1})">
|
|
<summary>
|
|
Registers an action used to post configure a particular type of options.
|
|
Note: These are run after all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``3(System.Action{`0,``0,``1,``2})">
|
|
<summary>
|
|
Registers an action used to post configure a particular type of options.
|
|
Note: These are run after all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``4(System.Action{`0,``0,``1,``2,``3})">
|
|
<summary>
|
|
Registers an action used to post configure a particular type of options.
|
|
Note: These are run after all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the action.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``5(System.Action{`0,``0,``1,``2,``3,``4})">
|
|
<summary>
|
|
Registers an action used to post configure a particular type of options.
|
|
Note: These are run after all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the action.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the action.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the action.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
|
|
<typeparam name="TDep5">The fifth dependency used by the action.</typeparam>
|
|
<param name="configureOptions">The action used to configure the options.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate(System.Func{`0,System.Boolean})">
|
|
<summary>
|
|
Register a validation action for an options type using a default failure message.
|
|
</summary>
|
|
<param name="validation">The validation function.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate(System.Func{`0,System.Boolean},System.String)">
|
|
<summary>
|
|
Register a validation action for an options type.
|
|
</summary>
|
|
<param name="validation">The validation function.</param>
|
|
<param name="failureMessage">The failure message to use when validation fails.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``1(System.Func{`0,``0,System.Boolean})">
|
|
<summary>
|
|
Register a validation action for an options type using a default failure message.
|
|
</summary>
|
|
<typeparam name="TDep">The dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``1(System.Func{`0,``0,System.Boolean},System.String)">
|
|
<summary>
|
|
Register a validation action for an options type.
|
|
</summary>
|
|
<typeparam name="TDep">The dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<param name="failureMessage">The failure message to use when validation fails.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``2(System.Func{`0,``0,``1,System.Boolean})">
|
|
<summary>
|
|
Register a validation action for an options type using a default failure message.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``2(System.Func{`0,``0,``1,System.Boolean},System.String)">
|
|
<summary>
|
|
Register a validation action for an options type.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<param name="failureMessage">The failure message to use when validation fails.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``3(System.Func{`0,``0,``1,``2,System.Boolean})">
|
|
<summary>
|
|
Register a validation action for an options type using a default failure message.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``3(System.Func{`0,``0,``1,``2,System.Boolean},System.String)">
|
|
<summary>
|
|
Register a validation action for an options type.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<param name="failureMessage">The failure message to use when validation fails.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``4(System.Func{`0,``0,``1,``2,``3,System.Boolean})">
|
|
<summary>
|
|
Register a validation action for an options type using a default failure message.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``4(System.Func{`0,``0,``1,``2,``3,System.Boolean},System.String)">
|
|
<summary>
|
|
Register a validation action for an options type.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<param name="failureMessage">The failure message to use when validation fails.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``5(System.Func{`0,``0,``1,``2,``3,``4,System.Boolean})">
|
|
<summary>
|
|
Register a validation action for an options type using a default failure message.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep5">The fifth dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``5(System.Func{`0,``0,``1,``2,``3,``4,System.Boolean},System.String)">
|
|
<summary>
|
|
Register a validation action for an options type.
|
|
</summary>
|
|
<typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
|
|
<typeparam name="TDep5">The fifth dependency used by the validation function.</typeparam>
|
|
<param name="validation">The validation function.</param>
|
|
<param name="failureMessage">The failure message to use when validation fails.</param>
|
|
<returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsCache`1">
|
|
<summary>
|
|
Used to cache <typeparamref name="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 <paramref name="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.TryGetValue(System.String,`0@)">
|
|
<summary>
|
|
Gets a named options instance, if available.
|
|
</summary>
|
|
<param name="name">The name of the options instance.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>true if the options were retrieved; otherwise, false.</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 <see cref="T:Microsoft.Extensions.Options.IOptionsFactory`1"/>.
|
|
</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="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}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IValidateOptions{`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>
|
|
<param name="validations">The validations to run.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsFactory`1.Create(System.String)">
|
|
<summary>
|
|
Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance to create.</param>
|
|
<returns>The created <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.</returns>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsFactory`1.CreateInstance(System.String)">
|
|
<summary>
|
|
Creates a new instance of options type.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance to create.</param>
|
|
<returns>The created <typeparamref name="TOptions"/> instance.</returns>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsManager`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IOptions`1"/> and <see cref="T:Microsoft.Extensions.Options.IOptionsSnapshot`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type.</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="P:Microsoft.Extensions.Options.OptionsManager`1.Value">
|
|
<summary>
|
|
The default configured <typeparamref name="TOptions"/> instance, equivalent to Get(Options.DefaultName).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsManager`1.Get(System.String)">
|
|
<summary>
|
|
Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance, if <see langword="null"/> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> is used.</param>
|
|
<returns>The <typeparamref name="TOptions"/> instance that matches the given <paramref name="name"/>.</returns>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsMonitor`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type.</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, equivalent to <c>Get(Options.DefaultName)</c>.
|
|
</summary>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.Get(System.String)">
|
|
<summary>
|
|
Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance, if <see langword="null"/> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> is used.</param>
|
|
<returns>The <typeparamref name="TOptions"/> instance that matches the given <paramref name="name"/>.</returns>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.OnChange(System.Action{`0,System.String})">
|
|
<summary>
|
|
Registers a listener to be called whenever <typeparamref name="TOptions"/> changes.
|
|
</summary>
|
|
<param name="listener">The action to be invoked when <typeparamref name="TOptions"/> has changed.</param>
|
|
<returns>An <see cref="T:System.IDisposable"/> which should be disposed to stop listening for changes.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.Dispose">
|
|
<summary>
|
|
Removes all change registration subscriptions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsMonitorExtensions">
|
|
<summary>
|
|
Extension methods for <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1"/>.
|
|
</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 <typeparamref name="TOptions"/> changes.
|
|
</summary>
|
|
<typeparam name="TOptions">The type of options instance being monitored.</typeparam>
|
|
<param name="monitor">The IOptionsMonitor.</param>
|
|
<param name="listener">The action to be invoked when <typeparamref name="TOptions"/> has changed.</param>
|
|
<returns>An <see cref="T:System.IDisposable"/> which should be disposed to stop listening for changes.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsValidationException">
|
|
<summary>
|
|
Thrown when options validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsValidationException.#ctor(System.String,System.Type,System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="optionsName">The name of the options instance that failed.</param>
|
|
<param name="optionsType">The options type that failed.</param>
|
|
<param name="failureMessages">The validation failure messages.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.OptionsValidationException.OptionsName">
|
|
<summary>
|
|
The name of the options instance that failed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.OptionsValidationException.OptionsType">
|
|
<summary>
|
|
The type of the options that failed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.OptionsValidationException.Failures">
|
|
<summary>
|
|
The validation failures.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.OptionsValidationException.Message">
|
|
<summary>
|
|
The message is a semicolon separated list of the <see cref="P:Microsoft.Extensions.Options.OptionsValidationException.Failures"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsValidatorAttribute">
|
|
<summary>
|
|
Triggers the automatic generation of the implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> at compile time.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.OptionsWrapper`1">
|
|
<summary>
|
|
<see cref="T:Microsoft.Extensions.Options.IOptions`1"/> wrapper that returns the options instance.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.#ctor(`0)">
|
|
<summary>
|
|
Initializes 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">Options type being configured.</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 <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Action"/> if the <paramref name="name"/> matches.
|
|
</summary>
|
|
<param name="name">The name of the action to invoke.</param>
|
|
<param name="options">The options to use in initialization.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.PostConfigureOptions`2">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep">Dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`2.#ctor(System.String,`1,System.Action{`0,`1})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency">A dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Dependency">
|
|
<summary>
|
|
The dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`2.PostConfigure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.PostConfigureOptions`2.PostConfigure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configured.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.PostConfigureOptions`3">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`3.#ctor(System.String,`1,`2,System.Action{`0,`1,`2})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`3.PostConfigure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.PostConfigureOptions`3.PostConfigure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configured.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.PostConfigureOptions`4">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`4.#ctor(System.String,`1,`2,`3,System.Action{`0,`1,`2,`3})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="dependency3">A third dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`4.PostConfigure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.PostConfigureOptions`4.PostConfigure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configured.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.PostConfigureOptions`5">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
<typeparam name="TDep4">Fourth dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Action{`0,`1,`2,`3,`4})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency1">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="dependency3">A third dependency.</param>
|
|
<param name="dependency4">A fourth dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency4">
|
|
<summary>
|
|
The fourth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`5.PostConfigure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.PostConfigureOptions`5.PostConfigure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configured.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.PostConfigureOptions`6">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">Options type being configured.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
<typeparam name="TDep4">Fourth dependency type.</typeparam>
|
|
<typeparam name="TDep5">Fifth dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Action{`0,`1,`2,`3,`4,`5})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">The name of the options.</param>
|
|
<param name="dependency1">A dependency.</param>
|
|
<param name="dependency2">A second dependency.</param>
|
|
<param name="dependency3">A third dependency.</param>
|
|
<param name="dependency4">A fourth dependency.</param>
|
|
<param name="dependency5">A fifth dependency.</param>
|
|
<param name="action">The action to register.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Action">
|
|
<summary>
|
|
The configuration action.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency4">
|
|
<summary>
|
|
The fourth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency5">
|
|
<summary>
|
|
The fifth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.PostConfigureOptions`6.PostConfigure(System.String,`0)">
|
|
<summary>
|
|
Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Action"/> if the <paramref name="name"/> matches.
|
|
</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="M:Microsoft.Extensions.Options.PostConfigureOptions`6.PostConfigure(`0)">
|
|
<summary>
|
|
Invoked to configure a <typeparamref name="TOptions"/> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
|
|
</summary>
|
|
<param name="options">The options instance to configured.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateEnumeratedItemsAttribute">
|
|
<summary>
|
|
Marks a field or property to be enumerated, and each enumerated object to be validated.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateEnumeratedItemsAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Options.ValidateEnumeratedItemsAttribute"/> class.
|
|
</summary>
|
|
<remarks>
|
|
Using this constructor for a field/property tells the code generator to
|
|
generate validation for the individual members of the enumerable's type.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateEnumeratedItemsAttribute.#ctor(System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Options.ValidateEnumeratedItemsAttribute"/> class.
|
|
</summary>
|
|
<param name="validator">A type that implements <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> for the enumerable's type.</param>
|
|
<remarks>
|
|
Using this constructor for a field/property tells the code generator to use the given type to validate
|
|
the object held by the enumerable.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateEnumeratedItemsAttribute.Validator">
|
|
<summary>
|
|
Gets the type to use to validate the enumerable's objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateObjectMembersAttribute">
|
|
<summary>
|
|
Marks a field or property to be validated transitively.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateObjectMembersAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Options.ValidateObjectMembersAttribute"/> class.
|
|
</summary>
|
|
<remarks>
|
|
Using this constructor for a field/property tells the code generator to
|
|
generate validation for the individual members of the field/property's type.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateObjectMembersAttribute.#ctor(System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Options.ValidateObjectMembersAttribute"/> class.
|
|
</summary>
|
|
<param name="validator">A type that implements <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> for the field/property's type.</param>
|
|
<remarks>
|
|
Using this constructor for a field/property tells the code generator to use the given type to validate
|
|
the object held by the field/property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateObjectMembersAttribute.Validator">
|
|
<summary>
|
|
Gets the type to use to validate a field or property.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptions`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`1.#ctor(System.String,System.Func{`0,System.Boolean},System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">Options name.</param>
|
|
<param name="validation">Validation function.</param>
|
|
<param name="failureMessage">Validation failure message.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`1.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`1.Validation">
|
|
<summary>
|
|
The validation function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`1.FailureMessage">
|
|
<summary>
|
|
The error to return when validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`1.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when <paramref name="name"/> is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptions`2">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
<typeparam name="TDep">Dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`2.#ctor(System.String,`1,System.Func{`0,`1,System.Boolean},System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">Options name.</param>
|
|
<param name="dependency">The dependency.</param>
|
|
<param name="validation">Validation function.</param>
|
|
<param name="failureMessage">Validation failure message.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`2.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`2.Validation">
|
|
<summary>
|
|
The validation function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`2.FailureMessage">
|
|
<summary>
|
|
The error to return when validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`2.Dependency">
|
|
<summary>
|
|
The dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`2.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when <paramref name="name"/> is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptions`3">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`3.#ctor(System.String,`1,`2,System.Func{`0,`1,`2,System.Boolean},System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">Options name.</param>
|
|
<param name="dependency1">The first dependency.</param>
|
|
<param name="dependency2">The second dependency.</param>
|
|
<param name="validation">Validation function.</param>
|
|
<param name="failureMessage">Validation failure message.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Validation">
|
|
<summary>
|
|
The validation function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`3.FailureMessage">
|
|
<summary>
|
|
The error to return when validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`3.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when <paramref name="name"/> is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptions`4">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`4.#ctor(System.String,`1,`2,`3,System.Func{`0,`1,`2,`3,System.Boolean},System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">Options name.</param>
|
|
<param name="dependency1">The first dependency.</param>
|
|
<param name="dependency2">The second dependency.</param>
|
|
<param name="dependency3">The third dependency.</param>
|
|
<param name="validation">Validation function.</param>
|
|
<param name="failureMessage">Validation failure message.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Validation">
|
|
<summary>
|
|
The validation function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`4.FailureMessage">
|
|
<summary>
|
|
The error to return when validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`4.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when <paramref name="name"/> is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptions`5">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
<typeparam name="TDep4">Fourth dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Func{`0,`1,`2,`3,`4,System.Boolean},System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">Options name.</param>
|
|
<param name="dependency1">The first dependency.</param>
|
|
<param name="dependency2">The second dependency.</param>
|
|
<param name="dependency3">The third dependency.</param>
|
|
<param name="dependency4">The fourth dependency.</param>
|
|
<param name="validation">Validation function.</param>
|
|
<param name="failureMessage">Validation failure message.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Validation">
|
|
<summary>
|
|
The validation function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.FailureMessage">
|
|
<summary>
|
|
The error to return when validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency4">
|
|
<summary>
|
|
The fourth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`5.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when <paramref name="name"/> is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptions`6">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
</summary>
|
|
<typeparam name="TOptions">The options type to validate.</typeparam>
|
|
<typeparam name="TDep1">First dependency type.</typeparam>
|
|
<typeparam name="TDep2">Second dependency type.</typeparam>
|
|
<typeparam name="TDep3">Third dependency type.</typeparam>
|
|
<typeparam name="TDep4">Fourth dependency type.</typeparam>
|
|
<typeparam name="TDep5">Fifth dependency type.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Func{`0,`1,`2,`3,`4,`5,System.Boolean},System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="name">Options name.</param>
|
|
<param name="dependency1">The first dependency.</param>
|
|
<param name="dependency2">The second dependency.</param>
|
|
<param name="dependency3">The third dependency.</param>
|
|
<param name="dependency4">The fourth dependency.</param>
|
|
<param name="dependency5">The fifth dependency.</param>
|
|
<param name="validation">Validation function.</param>
|
|
<param name="failureMessage">Validation failure message.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Name">
|
|
<summary>
|
|
The options name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Validation">
|
|
<summary>
|
|
The validation function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.FailureMessage">
|
|
<summary>
|
|
The error to return when validation fails.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency1">
|
|
<summary>
|
|
The first dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency2">
|
|
<summary>
|
|
The second dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency3">
|
|
<summary>
|
|
The third dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency4">
|
|
<summary>
|
|
The fourth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency5">
|
|
<summary>
|
|
The fifth dependency.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptions`6.Validate(System.String,`0)">
|
|
<summary>
|
|
Validates a specific named options instance (or all when <paramref name="name"/> is null).
|
|
</summary>
|
|
<param name="name">The name of the options instance being validated.</param>
|
|
<param name="options">The options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptionsResult">
|
|
<summary>
|
|
Represents the result of an options validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.Extensions.Options.ValidateOptionsResult.Skip">
|
|
<summary>
|
|
Result when validation was skipped due to name not matching.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.Extensions.Options.ValidateOptionsResult.Success">
|
|
<summary>
|
|
Validation was successful.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Succeeded">
|
|
<summary>
|
|
True if validation was successful.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Skipped">
|
|
<summary>
|
|
True if validation was not run.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Failed">
|
|
<summary>
|
|
True if validation failed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.FailureMessage">
|
|
<summary>
|
|
Used to describe why validation failed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Failures">
|
|
<summary>
|
|
Full list of failures (can be multiple).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResult.Fail(System.String)">
|
|
<summary>
|
|
Returns a failure result.
|
|
</summary>
|
|
<param name="failureMessage">The reason for the failure.</param>
|
|
<returns>The failure result.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResult.Fail(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Returns a failure result.
|
|
</summary>
|
|
<param name="failures">The reasons for the failure.</param>
|
|
<returns>The failure result.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.ValidateOptionsResultBuilder">
|
|
<summary>
|
|
Builds <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> with support for multiple error messages.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.#ctor">
|
|
<summary>
|
|
Creates new instance of the <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResultBuilder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.AddError(System.String,System.String)">
|
|
<summary>
|
|
Adds a new validation error to the builder.
|
|
</summary>
|
|
<param name="error">Content of error message.</param>
|
|
<param name="propertyName">The property in the option object which contains an error.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.AddResult(System.ComponentModel.DataAnnotations.ValidationResult)">
|
|
<summary>
|
|
Adds any validation error carried by the <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult"/> instance to this instance.
|
|
</summary>
|
|
<param name="result">The instance to append the error from.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.AddResults(System.Collections.Generic.IEnumerable{System.ComponentModel.DataAnnotations.ValidationResult})">
|
|
<summary>
|
|
Adds any validation error carried by the enumeration of <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult"/> instances to this instance.
|
|
</summary>
|
|
<param name="results">The enumeration to consume the errors from.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.AddResult(Microsoft.Extensions.Options.ValidateOptionsResult)">
|
|
<summary>
|
|
Adds any validation errors carried by the <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> instance to this instance.
|
|
</summary>
|
|
<param name="result">The instance to consume the errors from.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.Build">
|
|
<summary>
|
|
Builds <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> based on provided data.
|
|
</summary>
|
|
<returns>New instance of <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.ValidateOptionsResultBuilder.Clear">
|
|
<summary>
|
|
Reset the builder to the empty state
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions">
|
|
<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.OptionsBuilderExtensions.ValidateOnStart``1(Microsoft.Extensions.Options.OptionsBuilder{``0})">
|
|
<summary>
|
|
Enforces options validation check on start rather than in runtime.
|
|
</summary>
|
|
<typeparam name="TOptions">The type of options.</typeparam>
|
|
<param name="optionsBuilder">The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> to configure options instance.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
|
|
</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.AddOptionsWithValidateOnStart``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
|
|
<summary>
|
|
Adds services required for using options and enforces options validation check on start rather than in runtime.
|
|
</summary>
|
|
<remarks>
|
|
The <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions.ValidateOnStart``1(Microsoft.Extensions.Options.OptionsBuilder{``0})"/> extension is called by this method.
|
|
</remarks>
|
|
<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>
|
|
<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.AddOptionsWithValidateOnStart``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
|
|
<summary>
|
|
Adds services required for using options and enforces options validation check on start rather than in runtime.
|
|
</summary>
|
|
<remarks>
|
|
The <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions.ValidateOnStart``1(Microsoft.Extensions.Options.OptionsBuilder{``0})"/> extension is called by this method.
|
|
</remarks>
|
|
<typeparam name="TOptions">The options type to be configured.</typeparam>
|
|
<typeparam name="TValidateOptions">The <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> validator type.</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>
|
|
<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>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
|
<summary>
|
|
Registers a type that will have all of its <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>,
|
|
<see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>, and <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
registered.
|
|
</summary>
|
|
<typeparam name="TConfigureOptions">The type that will configure options.</typeparam>
|
|
<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.ConfigureOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Type)">
|
|
<summary>
|
|
Registers a type that will have all of its <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>,
|
|
<see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>, and <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
registered.
|
|
</summary>
|
|
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
|
|
<param name="configureType">The type that will configure 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.ConfigureOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Object)">
|
|
<summary>
|
|
Registers an object that will have all of its <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>,
|
|
<see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>, and <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/>
|
|
registered.
|
|
</summary>
|
|
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
|
|
<param name="configureInstance">The instance that will configure 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.AddOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
|
<summary>
|
|
Gets an options builder that forwards Configure calls for the same <typeparamref name="TOptions"/> to the underlying service collection.
|
|
</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>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that configure calls can be chained in it.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
|
|
<summary>
|
|
Gets an options builder that forwards Configure calls for the same named <typeparamref name="TOptions"/> to the underlying service collection.
|
|
</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>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that configure calls can be chained in it.</returns>
|
|
</member>
|
|
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
|
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
|
<param name="argument">The reference type argument to validate as non-null.</param>
|
|
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
|
</member>
|
|
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
|
<summary>
|
|
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
|
if the specified string is <see langword="null"/> or whitespace respectively.
|
|
</summary>
|
|
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
|
<param name="paramName">The name of the parameter being checked.</param>
|
|
<returns>The original value of <paramref name="argument"/>.</returns>
|
|
</member>
|
|
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
|
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_FailedBinding">
|
|
<summary>Failed to convert '{0}' to type '{1}'.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_FailedToActivate">
|
|
<summary>Failed to create instance of type '{0}'.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_MissingParameterlessConstructor">
|
|
<summary>Cannot create instance of type '{0}' because it is missing a public parameterless constructor.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_NoConfigurationServices">
|
|
<summary>No IConfigureOptions<>, IPostConfigureOptions<>, or IValidateOptions<> implementations were found.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_NoConfigurationServicesAndAction">
|
|
<summary>No IConfigureOptions<>, IPostConfigureOptions<>, or IValidateOptions<> implementations were found, did you mean to call Configure<> or PostConfigure<>?</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
|
<summary>
|
|
Attribute used to indicate a source generator should create a function for marshalling
|
|
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
|
</summary>
|
|
<remarks>
|
|
This attribute is meaningless if the source generator associated with it is not enabled.
|
|
The current built-in source generator only supports C# and only supplies an implementation when
|
|
applied to static, partial, non-generic methods.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
|
</summary>
|
|
<param name="libraryName">Name of the library containing the import.</param>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
|
<summary>
|
|
Gets the name of the library containing the import.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
|
<summary>
|
|
Gets or sets the name of the entry point to be called.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
|
<summary>
|
|
Gets or sets how to marshal string arguments to the method.
|
|
</summary>
|
|
<remarks>
|
|
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
|
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
|
<summary>
|
|
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
|
</summary>
|
|
<remarks>
|
|
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
|
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
|
<summary>
|
|
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
|
on other platforms) before returning from the attributed method.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
|
<summary>
|
|
Specifies how strings should be marshalled for generated p/invokes
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
|
<summary>
|
|
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
|
<summary>
|
|
Use the platform-provided UTF-8 marshaller.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
|
<summary>
|
|
Use the platform-provided UTF-16 marshaller.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|