ConnectedServiceHandlerContext Class

Visual Studio 2015

The context information and services given to ConnectedServiceHandlerinstances during UpdateServiceInstanceAsync and AddServiceInstanceAsync.

Namespace: Microsoft.VisualStudio.ConnectedServices
Assembly: Microsoft.VisualStudio.ConnectedServices (in Microsoft.VisualStudio.ConnectedServices.dll)

Inheritance Hierarchy

System::Object
Microsoft.VisualStudio.ConnectedServices::ConnectedServiceContext
Microsoft.VisualStudio.ConnectedServices::ConnectedServiceHandlerContext

Syntax

C++

public ref class ConnectedServiceHandlerContext abstract : ConnectedServiceContext

Constructors

	Name	Description
	ConnectedServiceHandlerContext()	This constructor supports unit testing your extension and is not intended to be used directly from your production code.

Properties

	Name	Description
	HandlerHelper	Gets 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 that indicates whether a connected service is being updated.(Inherited from ConnectedServiceContext.)
	Logger	Gets 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 the project's T:Microsoft.VisualStudio.Shell.Interop.IvsHierarchy that the current Connected Service dialog is operating on.(Inherited from ConnectedServiceContext.)
	ServiceInstance	Gets the instance of the service to add to the project.
	UpdateContext	Gets 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

	Name	Description
	CreateEditableXmlConfigHelper()	Creates an EditableXmlConfigHelper that can be used to read or write xml configuration files.
	CreateReadOnlyXmlConfigHelper()	Creates an CreateEditableXmlConfigHelper that can be used to read xml configuration files.(Inherited from ConnectedServiceContext.)
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetExtendedDesignerData<TData>()	Gets the designer data for the connected service that is stored in the ConnectedServices.json file for the service. Returns null if no extended designer data exists.(Inherited from ConnectedServiceContext.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	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.)
	ToString()	(Inherited from Object.)

Remarks

Instances of this class are provided by the Connected Services infrastructure. Do not inherit from this class in your production code.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.