ConnectedServiceHandlerContext Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.ConnectedServices

Assembly:: Microsoft.VisualStudio.ConnectedServices.dll

Package:: Microsoft.VisualStudio.ConnectedServices v16.2.45

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 context information and services given to ConnectedServiceHandler instances during AddServiceInstanceAsync and UpdateServiceInstanceAsync.

public ref class ConnectedServiceHandlerContext abstract : Microsoft::VisualStudio::ConnectedServices::ConnectedServiceContext

[Windows::Foundation::Metadata::WebHostHidden]
public ref class ConnectedServiceHandlerContext abstract : Microsoft::VisualStudio::ConnectedServices::ConnectedServiceContext

[Windows::Foundation::Metadata::WebHostHidden]
class ConnectedServiceHandlerContext abstract : Microsoft::VisualStudio::ConnectedServices::ConnectedServiceContext

public abstract class ConnectedServiceHandlerContext : Microsoft.VisualStudio.ConnectedServices.ConnectedServiceContext

type ConnectedServiceHandlerContext = class
    inherit ConnectedServiceContext

Public MustInherit Class ConnectedServiceHandlerContext
Inherits ConnectedServiceContext

Inheritance: Object

ConnectedServiceContext
ConnectedServiceHandlerContext

Remarks

Instances of this class are provided by the Connected Services infrastructure. It is not intended that you inherit from this class from your production code.

Constructors

ConnectedServiceHandlerContext()

Initializes a new instance of the ConnectedServiceHandlerContext class. This constructor supports unit testing your extension and is not intended to be used directly from your production code.

Properties

Args	Gets a property bag that contains the custom parameters that were specified when connected services session was launched. (Inherited from ConnectedServiceContext)
HandlerHelper	Gets or sets a ConnectedServiceHandlerHelper that can be used to perform project configuration tasks such as adding references, manipulating configuration files, and adding files to the project.
IsUpdating	Gets a value indicating whether a connected service is being updated. (Inherited from ConnectedServiceContext)
Logger	Gets or sets a logger that can be used to write any messages to the caller. This will include warnings of steps that did not succeed but can be fixed by the end user or errors that caused the operation to fail. (Inherited from ConnectedServiceContext)
ProjectHierarchy	Gets or sets the project's IVsHierarchy that the current Connected Service dialog is operating on. (Inherited from ConnectedServiceContext)
ServiceInstance	Gets or sets the instance of the service to add to the project.
UpdateContext	Gets or sets the information that is provided when a connected service is being updated, or null if the connected service is not being updated. (Inherited from ConnectedServiceContext)

Methods

CreateEditableXmlConfigHelper()	Creates an EditableXmlConfigHelper that can be used to read or write xml configuration files.
CreateReadOnlyXmlConfigHelper()	Creates an XmlConfigHelper that can be used to read xml configuration files. (Inherited from ConnectedServiceContext)
GetExtendedDesignerData<TData>()	Gets the designer data for the connected service that is stored in the ConnectedServices.json file for the service. (Inherited from ConnectedServiceContext)
SetExtendedDesignerData<TData>(TData)	Sets the designer data for the connected service that is stored in the ConnectedServices.json file for the service upon successfully adding/updating the service. (Inherited from ConnectedServiceContext)

Applies to