Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IOptionsMonitor<TOptions> Interface

Definition

Namespace:
Microsoft.Extensions.Options
Assembly:
Microsoft.Extensions.Options.dll
Package:
Microsoft.Extensions.Options v11.0.0-preview.5.26302.115
Source:
IOptionsMonitor.cs
Source:
IOptionsMonitor.cs
Source:
IOptionsMonitor.cs
Source:
IOptionsMonitor.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Monitors changes on a TOptions instance.

generic <typename TOptions>
public interface class IOptionsMonitor
public interface IOptionsMonitor<out TOptions>
type IOptionsMonitor<'Options> = interface
Public Interface IOptionsMonitor(Of Out TOptions)

Type Parameters

TOptions

The options type.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.
Derived

Properties

Name Description
CurrentValue

Gets the current TOptions instance with the DefaultName.

Methods

Name Description
Get(String)

Returns a configured TOptions instance with the given name.

OnChange(Action<TOptions,String>)

Registers a listener to be called whenever a named TOptions changes.

Extension Methods

Name Description
OnChange<TOptions>(IOptionsMonitor<TOptions>, Action<TOptions>)

Registers a listener to be called whenever TOptions changes.

Applies to


Feedback

Was this page helpful?