RemoteSettings Class

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 ref class RemoteSettings : Microsoft::VisualStudio::Telemetry::TelemetryDisposableObject, IDisposable, Microsoft::VisualStudio::RemoteSettings::IRemoteSettings, Microsoft::VisualStudio::RemoteSettings::IRemoteSettings2

public class RemoteSettings : Microsoft.VisualStudio.Telemetry.TelemetryDisposableObject, IDisposable, Microsoft.VisualStudio.RemoteSettings.IRemoteSettings, Microsoft.VisualStudio.RemoteSettings.IRemoteSettings2

type RemoteSettings = class
    inherit TelemetryDisposableObject
    interface IRemoteSettings
    interface IDisposable
    interface IRemoteSettings2

Public Class RemoteSettings
Inherits TelemetryDisposableObject
Implements IDisposable, IRemoteSettings, IRemoteSettings2

Inheritance

Object

TelemetryDisposableObject

RemoteSettings

Implements

IRemoteSettings IRemoteSettings2 IDisposable

Constructors

RemoteSettings(RemoteSettingsInitializer)

Construct a new Remote Setting instance with values taken from the initializer.

Properties

Default	Gets a default remote settings instance that uses a "Default.json" file.
IsDisposed	Gets a value indicating whether session is deposed - to detect redundant calls (Inherited from TelemetryDisposableObject)

Methods

CollectionExists(String)	Determines if the collection exists.
Dispose()	This code added to correctly implement the disposable pattern. (Inherited from TelemetryDisposableObject)
DisposeManagedResources()	User should implement it to dispose managed resources
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.
RequiresNotDisposed()	This function throws an ObjectDisposedException if the object is disposed. (Inherited from TelemetryDisposableObject)
Start()	Starts a background operation to check for new Remote Settings and apply them.
SubscribeActions<T>(String, Action<ActionWrapper<T>>)	Subscribes to triggered remote actions of type T on the given action path.
TryGetValue<T>(String, String, T)	Gets remote setting value if one exists.
UnsubscribeActions(String)	Unsubscribes to triggered remote actions on the given action path

Events

SettingsUpdated

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