Class ServiceCollectionExtensions

Namespace

OpenSettings.Extensions

Assembly

OpenSettings.dll

Provides extension methods to configure and add OpenSettings services to an IServiceCollection.

public static class ServiceCollectionExtensions

Inheritance

object

ServiceCollectionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddOpenSettings(IServiceCollection, OpenSettingsConfiguration, ProviderInfo)

Adds OpenSettings services to the application's IServiceCollection. This registers services necessary to run OpenSettings, based on the inherited ISettings types and the registration type.

public static IServiceCollection AddOpenSettings(this IServiceCollection services, OpenSettingsConfiguration openSettingsConfiguration, ProviderInfo providerInfo)

Parameters

services IServiceCollection

The IServiceCollection to which OpenSettings services will be added.

openSettingsConfiguration OpenSettingsConfiguration

The configuration that governs the behavior of OpenSettings (such as the service type: Provider or Consumer).

providerInfo ProviderInfo

Information about the provider being registered.

Returns

IServiceCollection

The IServiceCollection with OpenSettings services registered.

Exceptions

ArgumentNullException

Thrown if openSettingsConfiguration is null.

Configure(IServiceCollection, IConfigurationSection, Type)

public static IServiceCollection Configure(this IServiceCollection services, IConfigurationSection section, Type optionsType)

Parameters

services IServiceCollection

section IConfigurationSection

optionsType Type

Returns

IServiceCollection

ConfigureOpenSettings(IServiceCollection, IConfiguration)

Configures OpenSettings for the application by iterating over the OpenSettings.Constants.FullNameToLocalSetting and registering each setting type in the IServiceCollection based on the configuration.

This method is typically called during the UseOpenSettingsAsync(IHostBuilder, OpenSettingsConfiguration, params Type[]) extension to initialize OpenSettings configuration.

public static IServiceCollection ConfigureOpenSettings(this IServiceCollection services, IConfiguration configuration)

Parameters

services IServiceCollection

The IServiceCollection to which the OpenSettings services will be added.

configuration IConfiguration

The IConfiguration instance used to configure the settings.

Returns

IServiceCollection

The IServiceCollection with OpenSettings services configured.