TfsTeamProjectCollection Class

Abstracts common infrastructure for the Team Foundation system and is the parent class for Team Foundation components.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class TfsTeamProjectCollection _
    Inherits TfsConnection
public class TfsTeamProjectCollection : TfsConnection
public ref class TfsTeamProjectCollection : public TfsConnection
type TfsTeamProjectCollection =  
    class 
        inherit TfsConnection 
    end
public class TfsTeamProjectCollection extends TfsConnection

The TfsTeamProjectCollection type exposes the following members.

Constructors

Name Description
Public method TfsTeamProjectCollection(Uri) Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(RegisteredProjectCollection) Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(Uri, ICredentialsProvider) Obsolete. Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(Uri, TfsClientCredentials) Initializes a new TfsTeamProjectCollection instance using the specified credentials.
Public method TfsTeamProjectCollection(Uri, IdentityDescriptor) Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(Uri, Boolean)
Public method TfsTeamProjectCollection(Uri, ICredentials) Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(RegisteredProjectCollection, IdentityDescriptor) Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(Uri, TfsClientCredentials, IdentityDescriptor) Initializes a new TfsTeamProjectCollection instance using the specified credentials. The specified identity will be impersonated for all operations.
Public method TfsTeamProjectCollection(Uri, ICredentials, ICredentialsProvider) Obsolete. Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(RegisteredProjectCollection, ICredentials, ICredentialsProvider) Obsolete. Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(Uri, TfsClientCredentials, IdentityDescriptor, ITfsRequestChannelFactory)
Public method TfsTeamProjectCollection(Uri, TfsClientCredentials, IdentityDescriptor, Boolean)
Public method TfsTeamProjectCollection(Uri, ICredentials, ICredentialsProvider, IdentityDescriptor) Obsolete. Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(RegisteredProjectCollection, ICredentials, ICredentialsProvider, IdentityDescriptor) Obsolete. Initializes a new instance of the TfsTeamProjectCollection class.
Public method TfsTeamProjectCollection(Uri, TfsClientCredentials, IdentityDescriptor, ITfsRequestChannelFactory, Boolean)

Top

Properties

Name Description
Public property AuthorizedIdentity Gets the identity that is authorized to make calls to the server that is running Team Foundation Server. (Inherited from TfsConnection.)
Public property CatalogNode Gets the CatalogNode for this server. (Overrides TfsConnection.CatalogNode.)
Protected property CatalogResourceId (Inherited from TfsConnection.)
Public property ClientCacheDirectoryForInstance Gets the path of the directory that is used to cache data from the server that is running Team Foundation Server. (Inherited from TfsConnection.)
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] (Inherited from TfsConnection.)
Public property ClientCredentials Gets the credentials for this project collection. (Inherited from TfsConnection.)
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. (Inherited from TfsConnection.)
Public property ConfigurationServer Gets the TfsConfigurationServer for this instance.
Public property ConnectivityFailureOnLastWebServiceCall Indicates whether the last Web service call issued by this TfsConnection object failed due to a connectivity failure. (Inherited from TfsConnection.)
Public property Credentials Gets the credentials for this Team Foundation Server instance. (Inherited from TfsConnection.)
Public property Culture Gets or sets the localization environment that is used by the server that is running Team Foundation Server. (Inherited from TfsConnection.)
Public property DisplayName If there is only one collection registered with the server this will be just the server name otherwise it will be the same as name. e.g.
Public property HasAuthenticated Gets the status of a flag that describes whether this TfsConnection instance has successfully authenticated. (Inherited from TfsConnection.)
Public property InstanceId Gets the GUID that identifies this Team Foundation Server connection. (Inherited from TfsConnection.)
Public property IsHostedServer Returns true if the server is a Microsoft Azure-hosted Team Foundation Server server (Inherited from TfsConnection.)
Public property Name Gets the name of the server. (Overrides TfsConnection.Name.)
Public property ServerCapabilities The capabilities of the TFS server (Inherited from TfsConnection.)
Public property SessionId Gets the GUID that identifies this instance of the client to the server. (Inherited from TfsConnection.)
Public property TimeZone Gets or sets the time zone of this Team Foundation Server connection. Used to convert dates and times to UTC. (Inherited from TfsConnection.)
Public property UICulture The culture that will be used. It defaults to CultureInfo.CurrentUICulture. (Inherited from TfsConnection.)
Public property Uri Gets the uniform resource identifier (URI) for this Team Foundation Server connection. (Inherited from TfsConnection.)

Top

Methods

Name Description
Public method Authenticate Authenticates the connection to Team Foundation Server by using the specified credentials provider. (Inherited from TfsConnection.)
Public method Connect Connects to a server that is running Team Foundation Server and returns information based on connectOptions. (Inherited from TfsConnection.)
Protected method CreateInternalProxy (Inherited from TfsConnection.)
Protected method CreateServiceInstance (Inherited from TfsConnection.)
Protected method CreateVssConnection (Inherited from TfsConnection.)
Public method Dispose Notifies related objects of disposal and disposes of this instance of TfsConnection. (Inherited from TfsConnection.)
Public method EnsureAuthenticated Authenticates the connection to Team Foundation Server if it has not been previously authenticated. (Inherited from TfsConnection.)
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 (Inherited from TfsConnection.)
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. (Inherited from TfsConnection.)
Public method GetClient<T> (Inherited from TfsConnection.)
Public methodStatic member GetFullyQualifiedUriForName Gets the URI of the server that is associated with the specified name.
Public method GetHashCode Gets the hash code of this TfsConnection instance. (Inherited from TfsConnection.)
Public method GetService(Type) Gets the requested service. (Inherited from TfsConnection.)
Public method GetService<T>() Gets the requested service. (Inherited from TfsConnection.)
Protected method GetServiceInstance (Overrides TfsConnection.GetServiceInstance(Type, Object).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method InitializeTeamFoundationObject (Overrides TfsConnection.InitializeTeamFoundationObject(String, Object).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnConnectivityFailureStatusChanged Fires the ConnectivityFailureStatusChanged event. (Inherited from TfsConnection.)
Public method ToString Gets the name of the TfsConnection instance. (Inherited from TfsConnection.)

Top

Events

Name Description
Public event ConnectivityFailureStatusChanged This event is raised when the value of the ConnectivityFailureOnLastWebServiceCall flag changes. (Inherited from TfsConnection.)
Public event CredentialsChanged This event is raised when the credentials of the TeamFoundationServer object change. (Inherited from TfsConnection.)

Top

Remarks

Common infrastructure for all TfsTeamProjectCollection components:

  • Discovering a project collection.

  • Providing user credentials.

  • Providing globalization information.

  • Accessing team projects.

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