Share via

IAsyncStringStorage Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Settings
Assembly:
Microsoft.VisualStudio.Utilities.dll
Package:
Microsoft.VisualStudio.Utilities v17.9.37000

Stores and retrieves strings. Used as an abstraction over the settings service in the hub and unit-test mocks.

public interface class IAsyncStringStorage : System::ComponentModel::INotifyPropertyChanged
public interface IAsyncStringStorage : System.ComponentModel.INotifyPropertyChanged
type IAsyncStringStorage = interface
    interface INotifyPropertyChanged
Public Interface IAsyncStringStorage
Implements INotifyPropertyChanged
Implements
INotifyPropertyChanged

Methods

ClearAsync()
ClearAsync(CancellationToken)

Only used by tests. Does not fire change events.
DeleteIfExistsAsync(String)
DeleteIfExistsAsync(String, CancellationToken)
GetAllSinceVersionAsync(Int32)
GetAllSinceVersionAsync(Int32, CancellationToken)
GetAsync(String)
GetAsync(String, CancellationToken)
GetStoreIdentityAsync(CancellationToken)

Gets the unique ID for the settings store, which is randomly generated whenever the store is recreated.
SetAsync(NamedVersionedString)
SetAsync(NamedVersionedString, CancellationToken)

Creates or changes a setting value. The value provided will replace the existing value only if value.Revision.Revision is equal to the current revision of the value. The revision number increases each time the value is set.

Events

PropertyChangedAsync
StoreUpdated

Indicates the store has been updated, but what specific values may have changed is unknown. Clients maintaining cached copies of data should refetch in this case.

Applies to