ServiceDefinition Class

Defines a service and all of the locations that exist for it.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Client.ServiceDefinition

Namespace: Microsoft.TeamFoundation.Framework.Client
Assembly: Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

'Declaration
Public NotInheritable Class ServiceDefinition

public sealed class ServiceDefinition

public ref class ServiceDefinition sealed

[<Sealed>]
type ServiceDefinition =  class end

public final class ServiceDefinition

The ServiceDefinition type exposes the following members.

	Name	Description
	ServiceDefinition	Creates a ServiceDefinition based on the information supplied.

Top

	Name	Description
	Description	Text that documents or describes what this service is and how it is used.
	DisplayName	The display name for this ServiceDefinition.
	Identifier	The identifier for this instance of this service type. Together a ServiceType and an Identifier uniquely identify a ServiceDefinition.
	LocationMappings	The LocationMappings that define the location to AccessMapping relationships for FullyQualified ServiceDefinitions. For any ServiceDefinition that is relative, this will always be empty.
	RelativePath	The relative path for this ServiceDefinition. If the RelativeToSetting is FullyQualified, this value must be null, otherwise it must contain the portion of the path that is relative to whatever the relative setting is for the ServiceDefinition.
	RelativeToSetting	Inidicates whether the ServiceDefinition is relative to some aspect of the Team Foundation Server deployment or FullyQualified meaning that it is an external service. If this RelativeToSetting does not have a value of FullyQualified then the RelativePath must not be null or empty.
	ServiceType	This is the type of the service that is being defined. Note that multiple ServiceDefinitions can have the same ServiceType. Together a ServiceType and an Identifier uniquely identify a ServiceDefinition.
	ToolType	The Team Foundation Server Tool Type that this service is a member of.

Top

	Name	Description
	AddLocationMapping	Adds a LocationMapping for the provided AccessMapping and location to the ServiceDefinition. Note that if a LocationMapping already exists for the provided AccessMapping, it will be overwritten. Also, this method should only be called on ServiceDefinitions that are FullyQualified.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLocationMapping	Returns the LocationMapping for the AccessMapping provided or null if this ServiceDefinition does not have a LocationMapping for the provided AccessMapping. This function will always return null if it is called on a non-relative ServiceDefinition.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	RemoveLocationMapping	Removes the LocationMapping for the AccessMapping provided. Note that AccessMappings are determined to be equal based on their moniker.
	ToString	(Overrides Object.ToString().)

Top

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