AkavacheBuilderExtensions.GetSettingsStore(IAkavacheInstance, 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 T GetSettingsStore<T>(this IAkavacheInstance builder, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new() - 2.
public static T GetSettingsStore<T>(this IAkavacheInstance builder, string? overrideDatabaseName, IScheduler? scheduler) where T : class, ISettingsStorage, new() - 3.
public static T GetSettingsStore<T>(this IAkavacheInstance builder, IBlobCache cache, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new()
1. Overload¶
public static T GetSettingsStore<T>(this IAkavacheInstance builder, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new()
Summary: Gets or creates a standard settings store using SQLite for persistence.
Type parameters
| Name | Description |
|---|---|
T | The settings type that implements [ISettingsStorage](# |
Parameters
| Name | Type | Description |
|---|---|---|
builder | [IAkavacheInstance](# | The Akavache builder instance. |
overrideDatabaseName = null | string? | Optional override database name to use instead of the type name. |
Returns: T -- The settings store instance configured for standard storage.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown when builder is null. |
| System.InvalidOperationException | Thrown when AkavacheBuilder has not been initialized or serializer is not configured. |
2. Overload¶
public static T GetSettingsStore<T>(this IAkavacheInstance builder, string? overrideDatabaseName, IScheduler? scheduler) where T : class, ISettingsStorage, new()
Summary: Gets or creates a standard settings store using SQLite for persistence, optionally overriding the scheduler the underlying SqliteBlobCache uses. Pass Instance from tests to avoid thread-pool hops on the initialization observable.
Type parameters
| Name | Description |
|---|---|
T | The settings type that implements [ISettingsStorage](# |
Parameters
| Name | Type | Description |
|---|---|---|
builder | [IAkavacheInstance](# | The Akavache builder instance. |
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: T -- The settings store instance configured for standard storage.
3. Overload¶
public static T GetSettingsStore<T>(this IAkavacheInstance builder, IBlobCache cache, string? overrideDatabaseName = null) where T : class, ISettingsStorage, new()
Summary: Gets or creates a settings store using a custom IBlobCache instance. 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 | [IAkavacheInstance](# | The Akavache builder instance. |
cache | [IBlobCache](# | The custom blob cache instance to use for settings storage. |
overrideDatabaseName = null | string? | Optional override database name to use instead of the type name. |
Returns: T -- The settings store instance configured with the custom cache.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown when builder or cache is null. |
| System.InvalidOperationException | Thrown when AkavacheBuilder has not been initialized. |