Class PreferenceService

Namespace

The.Preferences

Assembly

Instagile.dll

public sealed class PreferenceService

Inheritance

object

PreferenceService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Clear()

public void Clear()

CreateAsync(IPreferenceStore, Func<string, IPrincipal?, IScopedContext>, ILogger)

public static Task<PreferenceService> CreateAsync(IPreferenceStore preferenceStore, Func<string, IPrincipal?, IScopedContext> createScopedContext, ILogger logger)

Parameters

preferenceStore IPreferenceStore

createScopedContext Func<string, IPrincipal, IScopedContext>

logger ILogger

Returns

Task<PreferenceService>

CreateFromSnapshot(IPreferenceStore, Func<string, IPrincipal?, IScopedContext>, ILogger, PreferenceDictionary)

public static PreferenceService CreateFromSnapshot(IPreferenceStore preferenceStore, Func<string, IPrincipal?, IScopedContext> createScopedContext, ILogger logger, PreferenceDictionary snapshot)

Parameters

preferenceStore IPreferenceStore

createScopedContext Func<string, IPrincipal, IScopedContext>

logger ILogger

snapshot PreferenceDictionary

Returns

PreferenceService

DisposeAsync()

public Task DisposeAsync()

Returns

Task

FlushAsync(CancellationToken?)

Save preferences for the current user

public Task FlushAsync(CancellationToken? cancellationToken = null)

Parameters

cancellationToken CancellationToken?

Returns

Task

FlushAsync(IPrincipal, CancellationToken?)

Save preferences for a specified user

public Task FlushAsync(IPrincipal principal, CancellationToken? cancellationToken = null)

Parameters

principal IPrincipal

cancellationToken CancellationToken?

Returns

Task

GetBoolean(string)

Read a boolean preference as a three-state value: null while the preference is unset.

public bool? GetBoolean(string key)

Parameters

key string

Returns

bool?

GetBoolean(string, bool)

public bool GetBoolean(string key, bool @default)

Parameters

key string

default bool

Returns

bool

GetDouble(string, double)

public double GetDouble(string key, double @default)

Parameters

key string

default double

Returns

double

GetInteger(string, int)

public int GetInteger(string key, int @default)

Parameters

key string

default int

Returns

int

GetString(string, string?)

public string? GetString(string key, string? @default)

Parameters

key string

default string

Returns

string

ReloadAsync(CancellationToken?)

Load or reload preferences for the current user, preserving current preferences otherwise.

public Task ReloadAsync(CancellationToken? cancellationToken = null)

Parameters

cancellationToken CancellationToken?

Returns

Task

ReloadAsync(IPrincipal, CancellationToken?)

Load or reload preferences for a specified user, resetting preferences otherwise.

public Task ReloadAsync(IPrincipal principal, CancellationToken? cancellationToken = null)

Parameters

principal IPrincipal

cancellationToken CancellationToken?

Returns

Task

SetBoolean(string, bool)

public void SetBoolean(string key, bool value)

Parameters

key string

value bool

SetDouble(string, double)

public void SetDouble(string key, double value)

Parameters

key string

value double

SetInteger(string, int)

public void SetInteger(string key, int value)

Parameters

key string

value int

SetString(string, string)

public void SetString(string key, string value)

Parameters

key string

value string

Unset(string)

Reset a preference value to the default.

public void Unset(string key)

Parameters

key string