ITDConnection2 Interface Members
Overview 
Public Methods
Public Method ChangePassword Deprecated. Changes the password for the currently logged in user.
Public Method Connect Connects the logged-in user to the specified project in the domain.
Public Method ConnectToVCSAs Obsolete. Do not invoke.
Public Method Disconnect Disconnects the user from the currently connected project.
Public Method DisconnectProject Disconnects from the project.
Public Method GetLicenses Allocates multiple licenses types according to the LicensesType parameter.
Public Method GetLicenseStatus The license status for the specified client type.
Public Method GetTDVersion The major and minor versions of the OTA API.
Public Method InitConnectionEx Initializes the connection.
Public Method Login

Authorizes the user. On success, the user is logged in and can connect to projects.

In ALM 14.x, the authorization is not handled by ALM but by an external Identity Manager (IdM) and Identity Provider (IdP).

The Login method is supported for backward compatibility and requires referencing IdmClientSdk.dll and IdmSdkWrapper.dll.

To take advantage of the new authentication mechanism, develop your own authentication flow to acquire a LWSSO token from the IdP and IdM that manage authentication (see Acquire an authentication token to use for ALM APIs). Use the token you acquire to call InitConnectionWithCookiesEx Method instead of using this Login method.

Public Method Logout Terminates the user's session on this TDConnection.
Public Method PurgeRuns Deletes the specified runs.
Public Method ReleaseConnection Releases the COM pointer created when the connection is initialized.
Public Method SendMail Sends Mail.
Public Method SynchronizeFollowUps Obsolete. Do not invoke.
Public Properties
Public Property ActionPermission The ActionPermission object for this connection.
Public Property AlertManager The AlertManager object for this connection.
Public Property AuditPropertyFactory The global AuditProperty factory, not associated with a specific entity.
Public Property AuditRecordFactory The global AuditRecord factory, not associated with a specific entity.
Public Property BugFactory The Bug Factory object for this connection.
Public Property CheckoutRepository The path of the checkout repository.
Public Property Command The Command object for this connection.
Public Property CommonSettings The Settings object for all users in this connection.
Public Property ComponentFolderFactory The Component Folder Factory object for this connection.
Public Property Connected Checks if the Open Test Architecture API server connection is initialized.
Public Property Customization The Customization object for this connection.
Public Property DBName The name of the database.
Public Property DBType The database type.
Public Property DirectoryPath The path of the server side repository directory for the database repository type.
Public Property DomainName The current domain.
Public Property DomainsList The domain names for this site.
Public Property ExtendedStorage Disabled by default security settings. Use the entity-level extended storage property.
Public Property Fields A list of fields for the table specified in the DataType argument.
Public Property GraphBuilder The GraphBuilder object for the connection.
Public Property HostFactory The Hosts Factory object for this connection.
Public Property HostGroupFactory The HostGroupFactory object for this connection.
Public Property IgnoreHtmlFormat Indicates if formatted memo and description fields are returned as plain text without HTML tags.
Public Property IsSearchSupported Checks if the search function is enabled for the project.
Public Property LoggedIn Checks if the user is currently logged in on this TDConnection.
Public Property MailConditions The TDMailConditions object for this connection.
Public Property ModuleVisible Checks if the specified module is visible to the connected user. This property is used for Quality Center UI programming and has no function in third-party applications.
Public Property ProductInfo An IProductInfo reference pointing to the current build information.
Public Property ProjectConnected Checks if the TDConnection is connected to a project.
Public Property ProjectName The name of the connected project.
Public Property ProjectProperties The ProjectProperties object for this connection.
Public Property ProjectsList The projects that are available in the domain to which Quality Center is connected.
Public Property ProjectsListEx The projects available within the specified domain.
Public Property ReportRole The report role of the connected user.
Public Property ReqFactory The ReqFactory object for this connection.
Public Property Rules The RuleManager object for this connection.
Public Property RunFactory The RunFactory object for this connection.
Public Property ServerName The name of the connected Open Test Architecture API server.
Public Property ServerTime The time and date of the application server.
Public Property ServerURL The URL of the connected server.
Public Property TDParams Gets the value of the parameter whose name is specified by Request.
Public Property TestFactory The Test Factory object for this connection.
Public Property TestRepository The path of the tests directory of the connected project.
Public Property TestSetFactory The Test Set Factory object for this connection.
Public Property TestSetTreeManager The TestSetTreeManager object for this connection.
Public Property TreeManager The TreeManager object for the system tree.
Public Property TSTestFactory The factory that manages test instances in test sets.
Public Property UserGroupsList The names of the user groups of the currently connected project.
Public Property UserName The user connected to the project.
Public Property UserSettings The Settings object for the logged-on user.
Public Property UsersList The names of the users of the currently connected project.
Public Property UsingProgress Indicates if a progress bar is displayed.
Public Property VcsDbRepository The path of the VCS database of the connected project.
Public Property VisibleDomains The list of domain names that the current logged in user is permitted to view.
Public Property VisibleProjects The list of projects in the specified domain that the current logged in user is allowed to connect to.
See Also