,System.String)} ,System.String,System.Reactive.Concurrency.IScheduler)} ,System.String)}
AkavacheBuilderExtensions.WithSettingsStore(IAkavacheBuilder, Action, string?) method¶
Defined in
Type: AkavacheBuilderExtensions
Namespace: Akavache.Settings
Assembly: Akavache.Settings.dll
Applies to
net10.0, net10.0-tvos26.0, net10.0-maccatalyst26.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net10.0-macos26.0, net10.0-windows10.0.19041, net10.0-ios26.0, net10.0-android36.0, net9.0, net9.0-windows10.0.19041, net9.0-browserwasm1.0, net9.0-desktop1.0, net8.0, net8.0-macos14.2, net8.0-maccatalyst17.5, net8.0-ios17.5, net8.0-tvos17.2, net8.0-windows10.0.19041, net8.0-macos14.5, netstandard2.1, net481, net462, net471
Overloads¶
- 1.
public static IAkavacheBuilder WithSettingsStore<T>(this IAkavacheBuilder builder, Action<T?> settings, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new() - 2.
public static IAkavacheBuilder WithSettingsStore<T>(this IAkavacheBuilder builder, Action<T?> settings, string? overrideDatabaseName, IScheduler? scheduler) where T : class, ISettingsStorage, new() - 3.
public static IAkavacheBuilder WithSettingsStore<T>(this IAkavacheBuilder builder, IBlobCache cache, Action<T?> settings, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new()
1. Overload¶
public static IAkavacheBuilder WithSettingsStore<T>(this IAkavacheBuilder builder, Action<T?> settings, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new()
Summary: Configures a standard settings store and initializes it using the provided configuration action.
Type parameters
| Name | Description |
|---|---|
T | The settings type that implements [ISettingsStorage](# |
Parameters
| Name | Type | Description |
|---|---|---|
builder | [IAkavacheBuilder](# | The Akavache builder to configure. |
settings | Action | Action to configure the settings instance once created. |
overrideDatabaseName = null | string? | Optional override database name to use instead of the type name. |
Returns: IAkavacheBuilder -- The builder instance for fluent configuration.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown when builder is null. |
2. Overload¶
public static IAkavacheBuilder WithSettingsStore<T>(this IAkavacheBuilder builder, Action<T?> settings, string? overrideDatabaseName, IScheduler? scheduler) where T : class, ISettingsStorage, new()
Summary:
Configures a standard settings store backed by SQLite using the supplied
scheduler. Intended for test harnesses that want to avoid
thread-pool scheduling on the cache initialization observable (pass
Instance).
Type parameters
| Name | Description |
|---|---|
T | The settings type. |
Parameters
| Name | Type | Description |
|---|---|---|
builder | [IAkavacheBuilder](# | The Akavache builder. |
settings | Action | Action to configure the settings instance once created. |
overrideDatabaseName | string? | Optional override database name to use instead of the type name. |
scheduler | [IScheduler?](# | Scheduler to use for the underlying blob cache, or null for the default task-pool scheduler. |
Returns: IAkavacheBuilder -- The builder instance for fluent configuration.
3. Overload¶
public static IAkavacheBuilder WithSettingsStore<T>(this IAkavacheBuilder builder, IBlobCache cache, Action<T?> settings, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new()
Summary: Configures a settings store using a custom IBlobCache instance and initializes it using the provided configuration action. This is useful for testing scenarios where an in-memory cache is preferred.
Type parameters
| Name | Description |
|---|---|
T | The settings type that implements [ISettingsStorage](# |
Parameters
| Name | Type | Description |
|---|---|---|
builder | [IAkavacheBuilder](# | The Akavache builder to configure. |
cache | [IBlobCache](# | The custom blob cache instance to use for settings storage. |
settings | Action | Action to configure the settings instance once created. |
overrideDatabaseName = null | string? | Optional override database name to use instead of the type name. |
Returns: IAkavacheBuilder -- The builder instance for fluent configuration.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown when builder or cache is null. |