TfsConnection Class

Article
07/02/2014

Represents the connection of the client to the server that is running Team Foundation Server.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Client.TfsConnection
    Microsoft.TeamFoundation.Client.TfsConfigurationServer
    Microsoft.TeamFoundation.Client.TfsTeamProjectCollection

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

Syntax

'Declaration
Public MustInherit Class TfsConnection _
    Implements IServiceProvider, IDisposable

public abstract class TfsConnection : IServiceProvider, 
    IDisposable

public ref class TfsConnection abstract : IServiceProvider, 
    IDisposable

[<AbstractClass>]
type TfsConnection =  
    class 
        interface IServiceProvider 
        interface IDisposable 
    end

public abstract class TfsConnection implements IServiceProvider, IDisposable

The TfsConnection type exposes the following members.

Properties

	Name	Description
	ApplicationName	Gets or sets the name of an application that is making a request on the server.
	AuthorizedIdentity	Gets the identity that is authorized to make calls to the server that is running Team Foundation Server.
	CatalogNode	Gets the catalog resource for this Team Foundation Server connection.
	CatalogResourceId
	ClientCacheDirectory	Gets the path of the directory that contains the client cache files.
	ClientCacheDirectoryForInstance	Gets the path of the directory that is used to cache data from the server that is running Team Foundation Server.
	ClientCacheDirectoryForUser	The path that should be used to cache user-specific data from this server. Accessing this property will make a server call to retrieve the user information if the server has not been connected. This will look something like this: %LOCALAPPDATA%\Microsoft\Team Foundation\[s_version]\Cache\[userId]\[instanceId]_[scheme]
	ClientConfigurationDirectory	Directory that contains the client configuration files which resides below the settings directory.This will resemble: C:\Documents and Settings\username\Local Settings\Application Data\Microsoft\Team Foundation\[s_version]\Configuration
	ClientCredentials	Gets the credentials for this project collection.
	ClientSettingsDirectory	Gets or sets the path of the directory that contains the client cache files.
	ClientVolatileCacheDirectory	Directory containing the client cache files that will be removed when their corresponding server connection is removed or replaced. This will look something like this: %LOCALAPPDATA%\Microsoft\Team Foundation\[s_version]\Cache\Volatile
	ClientVolatileCacheDirectoryForInstance	The path that should be used to cache instance-specific data from this server that will be removed when the server is removed or connected with a different user.
	ConnectivityFailureOnLastWebServiceCall	Indicates whether the last Web service call issued by this TfsConnection object failed due to a connectivity failure.
	Credentials	Gets the credentials for this Team Foundation Server instance.
	Culture	Gets or sets the localization environment that is used by the server that is running Team Foundation Server.
	HasAuthenticated	Gets the status of a flag that describes whether this TfsConnection instance has successfully authenticated.
	InstanceId	Gets the GUID that identifies this Team Foundation Server connection.
	IsHostedServer	Returns true if the server is a Microsoft Azure-hosted Team Foundation Server server
	Name	Gets the name of this Team Foundation Server connection.
	OperationName	Gets or sets the name of the operation that is being performed by an application on the server.
	ServerCapabilities	The capabilities of the TFS server
	SessionId	Gets the GUID that identifies this instance of the client to the server.
	TimeZone	Gets or sets the time zone of this Team Foundation Server connection. Used to convert dates and times to UTC.
	TotalRequestCount	The total number of times the WebServiceCallBegin event has fired in this appdomain.
	UICulture	The culture that will be used. It defaults to CultureInfo.CurrentUICulture.
	Uri	Gets the uniform resource identifier (URI) for this Team Foundation Server connection.

Top

Methods

	Name	Description
	Authenticate	Authenticates the connection to Team Foundation Server by using the specified credentials provider.
	Connect	Connects to a server that is running Team Foundation Server and returns information based on connectOptions.
	CreateInternalProxy
	CreateServiceInstance
	CreateVssConnection
	Dispose	Notifies related objects of disposal and disposes of this instance of TfsConnection.
	EnsureAuthenticated	Authenticates the connection to Team Foundation Server if it has not been previously authenticated.
	Equals	Returns true of the specified object is equal to this TfsConnection. Equality is defined by comparing the fully qualified url of the two TfsConnections (Overrides Object.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAuthenticatedIdentity	Gets the identity that authenticated with the server.
	GetClient<T>
	GetFullyQualifiedUriForName	This function assumes the name passed in will be either the friendly name of the server or the url to the root of the collection. Url's fully qualified to the location service page should not be passed in here.
	GetHashCode	Gets the hash code of this TfsConnection instance. (Overrides Object.GetHashCode().)
	GetService(Type)	Gets the requested service.
	GetService<T>()	Gets the requested service.
	GetServiceInstance
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeTeamFoundationObject	Initializes the created object if it implements ITfsConnectionObject.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnConnectivityFailureStatusChanged	Fires the ConnectivityFailureStatusChanged event.
	ToString	Gets the name of the TfsConnection instance. (Overrides Object.ToString().)

Top

Events

	Name	Description
	ConnectivityFailureStatusChanged	This event is raised when the value of the ConnectivityFailureOnLastWebServiceCall flag changes.
	CredentialsChanged	This event is raised when the credentials of the TeamFoundationServer object change.
	WebServiceCallBegin	This event is fired when the TFS client object model starts execution of a Web request in this appdomain. The receiving event handler will be provided with the instance of TfsConnection on which the Web service call originated (if available).
	WebServiceCallEnd	This event is fired when the TFS client object model finishes execution of a Web request in this appdomain. The receiving event handler will be provided with the instance of TfsConnection on which the Web service call originated (if available).

Top

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.

Partager via