Export (0) Print
Expand All

TfsConnection Class

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

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

public ref class TfsConnection abstract : IServiceProvider, 
	IDisposable

The TfsConnection type exposes the following members.

  NameDescription
Public propertyStatic memberApplicationNameGets or sets the name of an application that is making a request on the server.
Public propertyAuthorizedIdentityGets the identity that is authorized to make calls to the server that is running Team Foundation Server.
Public propertyCatalogNodeGets the catalog resource for this Team Foundation Server connection.
Protected propertyCatalogResourceId
Public propertyStatic memberClientCacheDirectoryGets the path of the directory that contains the client cache files.
Public propertyClientCacheDirectoryForInstanceGets the path of the directory that is used to cache data from the server that is running Team Foundation Server.
Public propertyClientCacheDirectoryForUserThe 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 memberClientConfigurationDirectoryDirectory 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 propertyClientCredentialsGets the credentials for this project collection.
Public propertyStatic memberClientSettingsDirectoryGets or sets the path of the directory that contains the client cache files.
Public propertyStatic memberClientVolatileCacheDirectoryDirectory 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 propertyClientVolatileCacheDirectoryForInstanceThe 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 propertyConnectivityFailureOnLastWebServiceCallIndicates whether the last Web service call issued by this TfsConnection object failed due to a connectivity failure.
Public propertyCredentialsGets the credentials for this Team Foundation Server instance.
Public propertyCultureGets or sets the localization environment that is used by the server that is running Team Foundation Server.
Public propertyHasAuthenticatedGets the status of a flag that describes whether this TfsConnection instance has successfully authenticated.
Public propertyInstanceIdGets the GUID that identifies this Team Foundation Server connection.
Public propertyIsHostedServerReturns true if the server is a Microsoft Azure-hosted Team Foundation Server server
Public propertyNameGets the name of this Team Foundation Server connection.
Public propertyStatic memberOperationNameGets or sets the name of the operation that is being performed by an application on the server.
Public propertyServerCapabilitiesThe capabilities of the TFS server
Public propertySessionIdGets the GUID that identifies this instance of the client to the server.
Public propertyTimeZoneGets or sets the time zone of this Team Foundation Server connection. Used to convert dates and times to UTC.
Public propertyStatic memberTotalRequestCountThe total number of times the WebServiceCallBegin event has fired in this appdomain.
Public propertyUICultureThe culture that will be used. It defaults to CultureInfo.CurrentUICulture.
Public propertyUriGets the uniform resource identifier (URI) for this Team Foundation Server connection.
Top

  NameDescription
Public methodAuthenticateAuthenticates the connection to Team Foundation Server by using the specified credentials provider.
Public methodConnectConnects to a server that is running Team Foundation Server and returns information based on connectOptions.
Protected methodCreateInternalProxy
Protected methodCreateServiceInstance
Protected methodCreateVssConnection
Public methodDisposeNotifies related objects of disposal and disposes of this instance of TfsConnection.
Public methodEnsureAuthenticatedAuthenticates the connection to Team Foundation Server if it has not been previously authenticated.
Public methodEqualsReturns 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 methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAuthenticatedIdentityGets the identity that authenticated with the server.
Public methodGetClient<T>
Protected methodStatic memberGetFullyQualifiedUriForNameThis 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 methodGetHashCodeGets the hash code of this TfsConnection instance. (Overrides Object::GetHashCode().)
Public methodGetService(Type)Gets the requested service.
Public methodGetService<T>()Gets the requested service.
Protected methodGetServiceInstance
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeTeamFoundationObjectInitializes the created object if it implements ITfsConnectionObject.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnConnectivityFailureStatusChangedFires the ConnectivityFailureStatusChanged event.
Public methodToStringGets the name of the TfsConnection instance. (Overrides Object::ToString().)
Top

  NameDescription
Public eventConnectivityFailureStatusChangedThis event is raised when the value of the ConnectivityFailureOnLastWebServiceCall flag changes.
Public eventCredentialsChangedThis event is raised when the credentials of the TeamFoundationServer object change.
Public eventStatic memberWebServiceCallBeginThis 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 memberWebServiceCallEndThis 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

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