ISettingsList Interface

Definition

A collection of settings. The collection is ordered but the server is order-agnostic. Items can be added only at the front but removed from anywhere. The collection is preserved by the server in the order it was created. Keys are treated as case insensitive.

public interface class ISettingsList
public interface class ISettingsList
__interface ISettingsList
public interface ISettingsList
type ISettingsList = interface
Public Interface ISettingsList

Remarks

Members of this interface may be called on any thread.

Properties

Keys

Gets a snapshot (not a "live" collection) of the keys in the list.

Methods

AddToFrontAsync(String, Object, Object)

Adds a new element to the front of the list. If there is already an element with the same key in the list, that one is deleted.

ClearAsync(Object)

Removes all elements from the list.

GetValueOrDefault<T>(String, T)

Returns the value corresponding to the given key. Returns defaultValue if the value is missing or not parsable as T.

RefreshContentFromStoreAsync()

In case the underlying store has gotten out of sync with the in-memory list representation (which can happen if another instance modifies the store, read the store content again and merge it with the in-memory list.

RemoveAsync(String, Object)

Removes a specific element from the list, or does nothing if the element is not found.

Events

CollectionChangedAsync

Applies to