TfsConnection Class

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
Public propertyStatic member ApplicationName Gets or sets the name of an application that is making a request on the server.
Public property AuthorizedIdentity Gets the identity that is authorized to make calls to the server that is running Team Foundation Server.
Public property CatalogNode Gets the catalog resource for this Team Foundation Server connection.
Protected property CatalogResourceId
Public propertyStatic member ClientCacheDirectory Gets the path of the directory that contains the client cache files.
Public property ClientCacheDirectoryForInstance Gets the path of the directory that is used to cache data from the server that is running Team Foundation Server.
Public property 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]
Public propertyStatic member 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
Public property ClientCredentials Gets the credentials for this project collection.
Public propertyStatic member ClientSettingsDirectory Gets or sets the path of the directory that contains the client cache files.
Public propertyStatic member 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
Public property 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.
Public property ConnectivityFailureOnLastWebServiceCall Indicates whether the last Web service call issued by this TfsConnection object failed due to a connectivity failure.
Public property Credentials Gets the credentials for this Team Foundation Server instance.
Public property Culture Gets or sets the localization environment that is used by the server that is running Team Foundation Server.
Public property HasAuthenticated Gets the status of a flag that describes whether this TfsConnection instance has successfully authenticated.
Public property InstanceId Gets the GUID that identifies this Team Foundation Server connection.
Public property IsHostedServer Returns true if the server is a Microsoft Azure-hosted Team Foundation Server server
Public property Name Gets the name of this Team Foundation Server connection.
Public propertyStatic member OperationName Gets or sets the name of the operation that is being performed by an application on the server.
Public property ServerCapabilities The capabilities of the TFS server
Public property SessionId Gets the GUID that identifies this instance of the client to the server.
Public property TimeZone Gets or sets the time zone of this Team Foundation Server connection. Used to convert dates and times to UTC.
Public propertyStatic member TotalRequestCount The total number of times the WebServiceCallBegin event has fired in this appdomain.
Public property UICulture The culture that will be used. It defaults to CultureInfo.CurrentUICulture.
Public property Uri Gets the uniform resource identifier (URI) for this Team Foundation Server connection.

Top

Methods

Name Description
Public method Authenticate Authenticates the connection to Team Foundation Server by using the specified credentials provider.
Public method Connect Connects to a server that is running Team Foundation Server and returns information based on connectOptions.
Protected method CreateInternalProxy
Protected method CreateServiceInstance
Protected method CreateVssConnection
Public method Dispose Notifies related objects of disposal and disposes of this instance of TfsConnection.
Public method EnsureAuthenticated Authenticates the connection to Team Foundation Server if it has not been previously authenticated.
Public method 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).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAuthenticatedIdentity Gets the identity that authenticated with the server.
Public method GetClient<T>
Protected methodStatic member 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.
Public method GetHashCode Gets the hash code of this TfsConnection instance. (Overrides Object.GetHashCode().)
Public method GetService(Type) Gets the requested service.
Public method GetService<T>() Gets the requested service.
Protected method GetServiceInstance
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method InitializeTeamFoundationObject Initializes the created object if it implements ITfsConnectionObject.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnConnectivityFailureStatusChanged Fires the ConnectivityFailureStatusChanged event.
Public method ToString Gets the name of the TfsConnection instance. (Overrides Object.ToString().)

Top

Events

Name Description
Public event ConnectivityFailureStatusChanged This event is raised when the value of the ConnectivityFailureOnLastWebServiceCall flag changes.
Public event CredentialsChanged This event is raised when the credentials of the TeamFoundationServer object change.
Public eventStatic member 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).
Public eventStatic member 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.

See Also

Reference

Microsoft.TeamFoundation.Client Namespace