Microsoft.VisualStudio.ConnectedServices Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The namespace of the Connected Services SDK (Microsoft.VisualStudio.ConnectedServices.dll) that enables a service provider to create a Visual Studio extension that adds the service to an app developer’s project through the Add Connected Services dialog.
Classes
AddFileOptions |
The options that control the behavior when adding a file to a project. |
AddServiceInstanceResult |
A result object that contains the information returned from ConnectedServiceHandler.AddServiceInstanceAsync(). |
AuthenticationChangedEventArgs |
An EventArgs class used when the authenticated state changes. |
ConfigureServiceOptions |
The options that control the behavior when configuring a connected service in a project. |
ConnectedServiceAuthenticator |
Allows the user to authenticate to the service. |
ConnectedServiceConfigurator |
The view model object used for displaying the Connected Service configuration dialog. |
ConnectedServiceConfiguredEventArgs |
An EventArgs class used when the a new Connected Service is configured |
ConnectedServiceContext |
A base class for the ConnectedServiceProviderContext and ConnectedServiceHandlerContext classes. |
ConnectedServiceCustomUIConfigurator |
A ConnectedServiceConfigurator that doesn't need to show UI to create a ConnectedServiceInstance. The information necessary to configure the connected service is available without user interaction. |
ConnectedServiceGrid |
A ConnectedServiceProvider service that shows a grid of instances, where a single instance can be chosen to add to the current project. |
ConnectedServiceHandler |
A MEF contract implemented by Connected Service authors in order to add a service instance reference to the project, including adding files, SDKs, and snippets. |
ConnectedServiceHandlerContext |
The context information and services given to ConnectedServiceHandler instances during AddServiceInstanceAsync and UpdateServiceInstanceAsync. |
ConnectedServiceHandlerExportAttribute |
Specifies that a type provides a ConnectedServiceHandler export. |
ConnectedServiceHandlerHelper |
A class that contains helper methods that ConnectedServiceHandler objects commonly use. |
ConnectedServiceInfo |
Provides information about a connected service that has been configured in a Visual Studio project. |
ConnectedServiceInstance |
A specific instance of a given service provided by the connected service provider. |
ConnectedServiceLogger |
A logging service which can be used to provide information to end user developers. |
ConnectedServiceProvider |
A MEF contract that is exported by extensions who wish to add new entries into the Add Connected Service dialog. |
ConnectedServiceProviderContext |
The context information and services given to ConnectedServiceProvider instances during CreateConfiguratorAsync. |
ConnectedServiceProviderExportAttribute |
Specifies that a type provides a ConnectedServiceProvider export. |
ConnectedServiceSinglePage |
A ConnectedServiceConfigurator that shows completely custom UI in a single step. |
ConnectedServicesManager |
A MEF contract implemented by the Connected Services to expose externally callable Connected Services functionality. |
ConnectedServiceUILess |
A ConnectedServiceConfigurator that doesn't need to show UI to create a ConnectedServiceInstance. The information necessary to configure the connected service is available without user interaction. |
ConnectedServiceUpdateContext |
ConnectedServiceUpdateContext holds the information that is provided when a connected service is being updated. |
ConnectedServiceViewModelBase |
A base class for all view model objects used in Connected Services. |
ConnectedServiceWizard |
A ConnectedServiceConfigurator that is capable of displaying multiple pages before the service is added to the project. |
ConnectedServiceWizardPage |
Represents a page, or step, in a wizard. |
DisplayMessageEventArgs |
Event args related to a display message |
DisplayMessageLogger |
Displays messages to the user in a UI |
EditableXmlConfigHelper |
Provides methods for editing configuration settings in the user's project. The Save method must be called to save any changes. |
GettingStartedDocument |
Contains information for launching the Getting Started documentation. |
KeyVaultEventArgs |
Provides data about a Key Vault is added event. |
PageNavigationResult |
Contains the result state after leaving a page in the Connected Services dialog. |
PublishEnvironment |
Contains settings that publish needs to know about connected service. It should be serialized inside of ExtendedData section inside of ConnectedService.json. |
SinglePageConfigurator |
An interface that is implemented by a Connected Service provider |
SinglePageConfigurator2 |
An interface that is implemented by a Connected Service provider |
UpdateServiceInstanceResult |
Contains information for launching GettingStarted information after UpdateServiceInstanceAsync has completed. |
WizardEnteringArgs |
The input arguments to the ConnectedServiceWizardPage.OnPageEnteringAsync method. |
WizardLeavingArgs |
The input arguments to the ConnectedServiceWizardPage.OnPageLeavingAsync method. |
XmlConfigHelper |
Provides methods for reading configuration settings in the user's project. |
Interfaces
IDisplayMessageLogger |
Displays messages to the user in a UI |
IVsHierarchyCustomEvaluator |
An optional interface that can be implemented by a ConnectedServiceHandler when it has an [ExportMetadata("CustomEvaluator", true)] attribute on it. This allows for any code to be written against the IVsHierarchy to indicate whether the handler supports the specified project. |
IVsProjectKeyVaultFactory |
A factory that creates an IVsProjectKeyVaultManager to get information regarding the Key Vault configured in the project |
IVsProjectKeyVaultManager |
An interface that can be used to get information about a Key Vault configured in a project |
SVsProjectKeyVaultFactory |
Interface for getting the IVsProjectKeyVaultFactory. |
Enums
LoggerMessageCategory |
The severity level of a message logged by ILogger. |
MessageCategory |
Category of the message to be logged |