Share via


ISettingsManagerHost5 Interface

Definition

public interface ISettingsManagerHost5 : Microsoft.VisualStudio.Settings.ISettingsManagerHost4
type ISettingsManagerHost5 = interface
    interface ISettingsManagerHost4
    interface ISettingsManagerHost3
    interface ISettingsManagerHost2
    interface ISettingsManagerHost
Public Interface ISettingsManagerHost5
Implements ISettingsManagerHost4
Implements

Properties

AppDir

Gets the application directory

(Inherited from ISettingsManagerHost)
AppInitCompletionTask

Optional task indicating the host is finished starting. The settings manager will defer resource-intensive tasks until after this task completes.

(Inherited from ISettingsManagerHost)
CollectionName

Gets the name of the settings collection to be addressed by this host. This is used to partition settings based on host parameters like VS's /rootSuffix parameter.

(Inherited from ISettingsManagerHost)
DurableHostIdentity

Additional process infomation. Use to add context to the log, does not need to follow any specific format.

(Inherited from ISettingsManagerHost4)
IsRoamingAndSharingAllowed

If false, prevents roaming and sharing regardless of the value of the setting that normally controls it.

IsRoamingEnabledByDefault

Gets a value indicating whether roaming and sharing should be enabled when the "RoamingEnabled" setting hasn't been persisted yet.

(Inherited from ISettingsManagerHost4)
Logger

A logger for error telemetry.

(Inherited from ISettingsManagerHost)
NameTranslator

Optional translator between private and shared setting names.

(Inherited from ISettingsManagerHost)
PrivateStorage

The backing store for private settings.

(Inherited from ISettingsManagerHost)
RemoteDefaultsStore

The remote defaults store to override setting defaults.

(Inherited from ISettingsManagerHost3)
StoreUpdateLogger

A logger for recording updates to setting stores. May be null.

(Inherited from ISettingsManagerHost4)
TelemetrySettings
Obsolete.

Gets the serialized telemetry settings from the host, obtained via ITelemetrySession.SerializeSettings. This may be null if the host has no telemetry session.

(Inherited from ISettingsManagerHost)

Methods

GetServiceStreamAsync(String, CancellationToken)
GetTelemetrySettingsAsync()

Gets the serialized telemetry settings from the host, obtained via ITelemetrySession.SerializeSettings. The result may be null if the host has no telemetry session.

(Inherited from ISettingsManagerHost2)
IsSharedOrRoamedSetting(String)

Determines whether a setting is private vs. shared/roamed.

(Inherited from ISettingsManagerHost)

Events

HostShuttingDown

Raised when the host is about to shut down, to give the settings manager an opportunity to release resources, finish or cancel async tasks, etc. The host should wait until the async event handler is complete (e.g. using the RaiseEventAsync<T>(Delegate, Object, T) extension method) before continuing.

(Inherited from ISettingsManagerHost)
IdleStateChanged

Raised when the host application goes idle or becomes active again, to enable reduced resource usage during the idle period.

(Inherited from ISettingsManagerHost)

Applies to