TeamFoundationServer Class

Article
11/19/2013

Note: This API is now obsolete.

Represents a connection to a server that is running Team Foundation Server.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Client.TeamFoundationServer

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

Syntax

'Declaration
<ObsoleteAttribute("")> _
Public Class TeamFoundationServer _
    Implements IServiceProvider, IDisposable

[ObsoleteAttribute("")]
public class TeamFoundationServer : IServiceProvider, 
    IDisposable

[ObsoleteAttribute(L"")]
public ref class TeamFoundationServer : IServiceProvider, 
    IDisposable

[<ObsoleteAttribute("")>]
type TeamFoundationServer =  
    class 
        interface IServiceProvider 
        interface IDisposable 
    end

public class TeamFoundationServer implements IServiceProvider, IDisposable

The TeamFoundationServer type exposes the following members.

Constructors

	Name	Description
	TeamFoundationServer(String)	Initializes a new TeamFoundationServer object that is associated with the specified URL.
	TeamFoundationServer(Uri)	Initializes a new TeamFoundationServer object that is associated with the specified URI.
	TeamFoundationServer(RegisteredProjectCollection)	Initializes a new TeamFoundationServer object that is associated with the server that is described by the specified RegisteredProjectCollection.
	TeamFoundationServer(String, ICredentialsProvider)	Initializes a new TeamFoundationServer object that is associated with the specified URL and credentials provider.
	TeamFoundationServer(String, ICredentials)	Initializes a new TeamFoundationServer object that is associated with the specified URL and credentials.
	TeamFoundationServer(Uri, ICredentialsProvider)	Initializes a new TeamFoundationServer object that is associated with the specified URI and credentials provider.
	TeamFoundationServer(Uri, ICredentials)	Initializes a new TeamFoundationServer object that is associated with the specified uniform resource identifier (URI) and credentials.
	TeamFoundationServer(String, ICredentials, ICredentialsProvider)	Initializes a new TeamFoundationServer object that is associated with the specified URL and credentials.
	TeamFoundationServer(Uri, ICredentials, ICredentialsProvider)	Initializes a new TeamFoundationServer object that is associated with the specified URI, credentials and credentials provider.
	TeamFoundationServer(RegisteredProjectCollection, ICredentials, ICredentialsProvider)	Initializes a new TeamFoundationServer object that is associated with the server that is described by the specified RegisteredProjectCollection, credentials, and credentials provider.

Top

Properties

	Name	Description
	AuthenticatedUserDisplayName	Gets the display name of the authenticated user.
	AuthenticatedUserIdentity	Gets the authenticated user's identity.
	AuthenticatedUserName	Gets the authenticated user name.
	ClientCacheDirectory	Gets the directory that contains the client cache files.
	ClientCacheDirectoryForInstance	Gets the directory to use when data is cached from the server.
	ClientSettingsDirectory	Gets or sets the directory that contains the client settings files.
	Credentials	Gets the credentials for this TeamFoundationServer object.
	Culture	Gets or sets the culture to use for this TeamFoundationServer object.
	HasAuthenticated	Gets a flag that describes whether this TeamFoundationServer object has successfully authenticated.
	InstanceId	Gets the GUID that uniquely identifies the server.
	Name	Gets the name of the server that is running Team Foundation Server.
	SessionId	Gets the GUID that identifies this TeamFoundationServer object to the server and is recorded in the activity log of the server.
	TfsTeamProjectCollection	Gets the TfsTeamProjectCollection instance that is associated with this TeamFoundationServer object.
	TimeZone	Gets or sets the time zone.
	Uri	Gets the URI of the current server that is running Team Foundation Server.

Top

Methods

	Name	Description
	Authenticate	Authenticates the connection with the server.
	Dispose	Notifies interested objects of disposal and disposes this object.
	EnsureAuthenticated	Authenticates the connection, if it was not previously authenticated.
	Equals	Checks to see whether this TeamFoundationServer object is equal to the specified object. (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.)
	GetHashCode	Gets the hash code for this object. (Overrides Object.GetHashCode().)
	GetService(Type)	Gets the specified service.
	GetService<T>()	Gets the specified service.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Gets the name of this TeamFoundationServer object. (Overrides Object.ToString().)

Top

Events

	Name	Description
	CredentialsChanged	This event occurs when the credentials of the TeamFoundationServer object change.

Top

Operators

	Name	Description
	Equality	Checks to see if the specified TeamFoundationServer objects are equal.
	Inequality	Checks to see whether the specified TeamFoundationServer objects are not equal.

Top

Remarks

This class is obsolete. Use the TfsTeamProjectCollection or TfsConfigurationServer classes instead.

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.

Share via