IRemoteSettings Interface

Definition

Namespace:

Microsoft.VisualStudio.RemoteSettings

Assembly:

Microsoft.VisualStudio.Telemetry.dll

Package:

Microsoft.VisualStudio.Telemetry v17.12.48

Remote settings provide configurable settings without code changes.

public interface class IRemoteSettings : IDisposable

public interface IRemoteSettings : IDisposable

type IRemoteSettings = interface
    interface IDisposable

Public Interface IRemoteSettings
Implements IDisposable

Derived

Microsoft.VisualStudio.RemoteSettings.RemoteSettings

Implements

IDisposable

Methods

CollectionExists(String)	Determines if the collection exists.
GetActionsAsync<T>(String)	Gets all remote actions of type T, wrapped in ActionWrapper. Waits for the call to Targeted Notifications backend to complete. Must be called after Start.
GetPropertyNames(String)	Gets all the property names under a specific collection.
GetSubCollectionNames(String)	Gets all the sub-collection names under a specific collection.
GetValue<T>(String, String, T)	Gets a remote setting value that is updated with both Targeted Notifications backend and RemoteControl file. This does not return the most up-to-date setting, but the value of whatever RemoteSettings has processed so far.
GetValueAsync<T>(String, String, T)	Gets a remote setting value, that is updated with both Targeted Notifications backend and RemoteControl file. Must be called after Start.
GetValueKind(String, String)	Gets kind of a remote setting value.
PropertyExists(String, String)	Determines if the property exists.
RegisterFilterProvider(IScopeFilterProvider)	Add a scope filter provider. Not implemented yet.
Start()	Starts a background operation to check for new Remote Settings on both Targeted Notifictions and Remote Control backend and apply them.
TryGetValue<T>(String, String, T)	Gets remote setting value if one exists.

Events

SettingsUpdated

Subscribe to this event to be notified when Remote Settings have been updated.