Share this page
ITDConnection2 Interface
Description
Represents a single server connection.
Public Methods
 ChangePassword | Deprecated. Changes the password for the currently logged in user. |
| Connect | Connects the logged-in user to the specified project in the domain. |
| ConnectToVCSAs | Obsolete. Do not invoke. |
| Disconnect | Disconnects the user from the currently connected project. |
| DisconnectProject | Disconnects from the project. |
| GetLicenses | Allocates multiple licenses types according to the LicensesType parameter. |
| GetLicenseStatus | The license status for the specified client type. |
| GetTDVersion | The major and minor versions of the OTA API. |
| InitConnectionEx | Initializes the connection. |
| 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. |
| Logout | Terminates the user's session on this TDConnection. |
| PurgeRuns | Deletes the specified runs. |
| ReleaseConnection | Releases the COM pointer created when the connection is initialized. |
| SendMail | Sends Mail. |
| SynchronizeFollowUps | Obsolete. Do not invoke. |
Public Properties
 ActionPermission | The ActionPermission object for this connection. |
| AlertManager | The AlertManager object for this connection. |
| AuditPropertyFactory | The global AuditProperty factory, not associated with a specific entity. |
| AuditRecordFactory | The global AuditRecord factory, not associated with a specific entity. |
| BugFactory | The Bug Factory object for this connection. |
| CheckoutRepository | The path of the checkout repository. |
| Command | The Command object for this connection. |
| CommonSettings | The Settings object for all users in this connection. |
| ComponentFolderFactory | The Component Folder Factory object for this connection. |
| Connected | Checks if the Open Test Architecture API server connection is initialized. |
| Customization | The Customization object for this connection. |
| DBName | The name of the database. |
| DBType | The database type. |
| DirectoryPath | The path of the server side repository directory for the database repository type. |
| DomainName | The current domain. |
| DomainsList | The domain names for this site. |
| ExtendedStorage | Disabled by default security settings. Use the entity-level extended storage property. |
| Fields | A list of fields for the table specified in the DataType argument. |
| GraphBuilder | The GraphBuilder object for the connection. |
| HostFactory | The Hosts Factory object for this connection. |
| HostGroupFactory | The HostGroupFactory object for this connection. |
| IgnoreHtmlFormat | Indicates if formatted memo and description fields are returned as plain text without HTML tags. |
| IsSearchSupported | Checks if the search function is enabled for the project. |
| LoggedIn | Checks if the user is currently logged in on this TDConnection. |
| MailConditions | The TDMailConditions object for this connection. |
| 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. |
| ProductInfo | An IProductInfo reference pointing to the current build information. |
| ProjectConnected | Checks if the TDConnection is connected to a project. |
| ProjectName | The name of the connected project. |
| ProjectProperties | The ProjectProperties object for this connection. |
| ProjectsList | The projects that are available in the domain to which Quality Center is connected. |
| ProjectsListEx | The projects available within the specified domain. |
| ReportRole | The report role of the connected user. |
| ReqFactory | The ReqFactory object for this connection. |
| Rules | The RuleManager object for this connection. |
| RunFactory | The RunFactory object for this connection. |
| ServerName | The name of the connected Open Test Architecture API server. |
| ServerTime | The time and date of the application server. |
| ServerURL | The URL of the connected server. |
| TDParams | Gets the value of the parameter whose name is specified by Request. |
| TestFactory | The Test Factory object for this connection. |
| TestRepository | The path of the tests directory of the connected project. |
| TestSetFactory | The Test Set Factory object for this connection. |
| TestSetTreeManager | The TestSetTreeManager object for this connection. |
| TreeManager | The TreeManager object for the system tree. |
| TSTestFactory | The factory that manages test instances in test sets. |
| UserGroupsList | The names of the user groups of the currently connected project. |
| UserName | The user connected to the project. |
| UserSettings | The Settings object for the logged-on user. |
| UsersList | The names of the users of the currently connected project. |
| UsingProgress | Indicates if a progress bar is displayed. |
| VcsDbRepository | The path of the VCS database of the connected project. |
| VisibleDomains | The list of domain names that the current logged in user is permitted to view. |
| VisibleProjects | The list of projects in the specified domain that the current logged in user is allowed to connect to. |
See Also
