OptionsMonitor<TOptions> Class

Reference

Definition

Namespace:: Microsoft.Extensions.Options

Assembly:: Microsoft.Extensions.Options.dll

Package:: Microsoft.Extensions.Options v10.0.0-preview.1.25080.5

Source:: OptionsMonitor.cs

Source:: OptionsMonitor.cs

Source:: OptionsMonitor.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.

Implements IOptionsMonitor<TOptions>.

generic <typename TOptions>
 where TOptions : classpublic ref class OptionsMonitor : IDisposable, Microsoft::Extensions::Options::IOptionsMonitor<TOptions>

public class OptionsMonitor<TOptions> : IDisposable, Microsoft.Extensions.Options.IOptionsMonitor<TOptions> where TOptions : class

type OptionsMonitor<'Options (requires 'Options : null)> = class
    interface IOptionsMonitor<'Options (requires 'Options : null)>
    interface IDisposable

Public Class OptionsMonitor(Of TOptions)
Implements IDisposable, IOptionsMonitor(Of TOptions)

Type Parameters

TOptions

The options type.

Inheritance: Object
OptionsMonitor<TOptions>

Implements: IOptionsMonitor<TOptions> IDisposable

Constructors

OptionsMonitor<TOptions>(IOptionsFactory<TOptions>, IEnumerable<IOptionsChangeTokenSource<TOptions>>, IOptionsMonitorCache<TOptions>)

Initializes a new instance of OptionsMonitor<TOptions> with the specified factory, sources, and cache.

Properties

CurrentValue

Gets the present value of the options (equivalent to Get(Options.DefaultName)).

Methods

Dispose()	Removes all change registration subscriptions.
Get(String)	Returns a configured `TOptions` instance with the given `name`.
OnChange(Action<TOptions,String>)	Registers a listener to be called whenever `TOptions` changes.

Extension Methods

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

Registers a listener to be called whenever TOptions changes.

Applies to

Toode	Versioonid
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard	2.0 (package-provided), 2.1 (package-provided)

Jagamisviis: