TDConnection Object Members
Public Methods
Public Method ApplyClientCertApply client certificate to connection, the parameter should be valid CERT_CONTEXT structure.
Public Method ApplyCookieApplies cookie to connection
Public Method ChangePasswordDeprecated. Changes the password for the currently logged in user.
Public Method ConnectConnects the logged-in user to the specified project in the domain.
Public Method ConnectToVCSAsObsolete. Do not invoke.
Public Method CreateBSTRMapCreate an IBSTRMap, If you create it you must release it. In C#: System.Runtime.InteropServices.Marshal.ReleaseComObject(map);
Public Method CreateSessionCreates application session on server, similar to login operation but for SSO configuration.
Public Method DisconnectDisconnects the user from the currently connected project.
Public Method DisconnectProjectDisconnects from the project.
Public Method GetAllVisibleProjectDescriptorsThe list of project descriptors under all domains that the current logged in user is allowed to connect to.
Public Method GetApprovalIdObtain approval token.
Public Method GetAuthenticationTokenGet access token by approval token.
Public Method GetCommonFavoriteFactoryReturns the factory that manages favorites.
Public Method GetCommonFavoriteFolderFactoryReturns the factory that manages favorite folders.
Public Method GetLicensesAllocates multiple licenses types according to the LicensesType parameter.
Public Method GetLicensesExAllocates multiple licenses types according to the LicensesType parameter.
Public Method GetLicenseStatusThe license status for the specified client type.
Public Method GetLinkedProjectsThe project list of linked projects to this project.
Public Method GetTDParamsNamesReturns the names of the site's parameters.
Public Method GetTDVersionThe major and minor versions of the OTA API.
Public Method GetTDVersionExThe major, minor, minor-minor versions and build number of the OTA API.
Public Method ImportConnectionSettingsImport of connection settings to connection
Public Method ImportConnectionSettings2Import extended settings to connection.
Public Method InitAndCheckServerCompatibilityInitialize connection and check whether server version is compatible with OTA
Public Method InitConnectionExInitializes the connection.
Public Method InitConnectionWithCookiesInitialize connection with provided SSO token cookie
Public Method InitConnectionWithCookiesEx

Initialize the connection with an ALM server using a LWSSO token you acquired from the IdP and IdM that manage authentication. For details, see Acquire an authentication token to use for ALM APIs.

IdP is supported only in ALM 14.x.

Public Method IsSSPREnabledReturns whether Self-Service Password Reset is enabled.
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 use the ALM 14.x 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 LogoutTerminates the user's session on this TDConnection.
Public Method PurgeRunsDeletes the specified runs.
Public Method PurgeRuns2Deletes the specified runs.
Public Method RefreshConnectionStateRefreshes the connection state: updates the Connected, LoggedIn, and ProjectConnected properties.
Public Method ReleaseConnectionReleases the COM pointer created when the connection is initialized.
Public Method SendFramedMailSends Mail.
Public Method SendFramedMailExSends Mail.
Public Method SendMailSends Mail.
Public Method SendMailExSends Mail.
Public Method SendMailWithCCSends Mail.
Public Method SetBasicAuthHeaderModeSet basic auth header mode
Public Method SetConnectionSettingsLockKeySet connection settings lock key.
Public Method SetExecutionModeSet execution mode to WebClient
Public Method SetProxyCredentialsSets credentials for authentication on proxy.
Public Method SetServerCredentialsSets credentials for authentication on server.
Public Method SSPRChangePasswordSend the new password, SSPR_CIPHER, name (the user name that user entered in change password window, if it is impersonate this meby different from the real user name), to the server.
Public Method SSPRSendMailSend email that contain SSPR_LINK (URL + Cipher (user name + GUID) ) for change password window.
Public Method SynchronizeFollowUpsObsolete. Do not invoke.
Public Method UseInstanceCacheUse instance cache of settings storages
Public Properties
Public Property ActionPermissionThe ActionPermission object for this connection.
Public Property AlertManagerThe AlertManager object for this connection.
Public Property AssetRelationFactoryThe AssetsRelationFactory object for this connection.
Public Property AssetRepositoryItemFactoryThe AssetRepositoryItemFactory object for this connection.
Public Property AsyncMailEnabledChecks if asynchronous mailing is enabled for the project.
Public Property AuditPropertyFactoryThe global AuditProperty factory, not associated with a specific entity.
Public Property AuditRecordFactoryThe global AuditRecord factory, not associated with a specific entity.
Public Property BPComponentFactoryThe BPComponentFactory object for this connection.
Public Property BPIterationFactoryThe BPIterationFactory object for this connection.
Public Property BPIterationParamFactoryGet BPIterationParamFactory object for this connection.
Public Property BPModelElementFactoryThe BPModelElementFactory object for this connection.
Public Property BPModelFactoryThe BPModelFactory object for this connection.
Public Property BPModelFolderFactoryThe BPModelFolderFactory object for this connection.
Public Property BPModelPathFactoryThe BPModelPathFactory object for this connection.
Public Property BPParamFactoryGet BPParamFactory object for this connection.
Public Property BugFactoryThe Bug Factory object for this connection.
Public Property CheckoutRepositoryThe path of the checkout repository.
Public Property CommandThe Command object for this connection.
Public Property CommonSettingsThe Settings object for all users in this connection.
Public Property ComponentFolderFactoryThe Component Folder Factory object for this connection.
Public Property ComponentParamFactoryThe ComponentParamFactory object for this connection.
Public Property ComponentStepFactoryThe ComponentStepFactory object for this connection.
Public Property ConnectedChecks if the Open Test Architecture API server connection is initialized.
Public Property CoverageFactoryThe CoverageFactory for the connection.
Public Property CustomizationThe Customization object for this connection.
Public Property DBNameThe name of the database.
Public Property DBTypeThe database type.
Public Property DeletedAssetInfoFactoryThe DeletedAssetInfoFactory object for this connection.
Public Property DesignStepFactoryThe DesignStepFactory object for this connection.
Public Property DirectoryPathThe path of the server side repository directory for the database repository type.
Public Property DomainNameThe current domain.
Public Property DomainsListThe domain names for this site.
Public Property ExtendedStorageDisabled by default security settings. Use the entity-level extended storage property.
Public Property ExternalAuthenticationEnabledChecks if external authentication enabled on server
Public Property FieldsA list of fields for the table specified in the DataType argument.
Public Property GraphBuilderThe GraphBuilder object for the connection.
Public Property HostFactoryThe Hosts Factory object for this connection.
Public Property HostGroupFactoryThe HostGroupFactory object for this connection.
Public Property IgnoreHtmlFormatIndicates if formatted memo and description fields are returned as plain text without HTML tags.
Public Property IsSearchSupportedChecks if the search function is enabled for the project.
Public Property IsServerCompatibleGet Compatibility of OTA to Server
Public Property LoggedInChecks if the user is currently logged in on this TDConnection.
Public Property LoginMetadataGets metadata on different project types.
Public Property LoginSessionIdThe login session ID.
Public Property MailConditionsThe TDMailConditions object for this connection.
Public Property ModuleVisibleChecks 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 PolicyStatusThe Policy Enforcement Status object of the connected project.
Public Property ProductInfoAn IProductInfo reference pointing to the current build information.
Public Property ProjectConnectedChecks if the TDConnection is connected to a project.
Public Property ProjectNameThe name of the connected project.
Public Property ProjectPropertiesThe ProjectProperties object for this connection.
Public Property ProjectSessionIdThe project session ID.
Public Property ProjectsListThe projects that are available in the domain to which Quality Center is connected.
Public Property ProjectsListExThe projects available within the specified domain.
Public Property QCResourceFactoryThe QC resource factory object for this connection.
Public Property QCResourceFolderFactoryThe QC resource folder factory object for this connection.
Public Property ReleaseFolderFactoryThe factory that manages release folders.
Public Property ReportRoleThe report role of the connected user.
Public Property ReqFactoryThe ReqFactory object for this connection.
Public Property RulesThe RuleManager object for this connection.
Public Property RunCriterionFactoryThe RunCriterionFactory object for this connection.
Public Property RunFactoryThe RunFactory object for this connection.
Public Property RunIterationFactoryThe RunIterationFactory object for this connection.
Public Property ServerNameThe name of the connected Open Test Architecture API server.
Public Property ServerTimeThe time and date of the application server.
Public Property ServerURLThe URL of the connected server.
Public Property ServiceChangeFactoryThe service change factory object for this connection.
Public Property ServiceFactoryThe service factory object for this connection.
Public Property ServiceFolderFactoryThe service folder factory object for this connection.
Public Property ServiceGroupFactoryThe service group factory object for this connection.
Public Property StepFactoryThe Step Factory for this connection.
Public Property TDParamsGets the value of the parameter whose name is specified by Request.
Public Property TemplateManagerThe Template Manager object of the connected project.
Public Property TestConfigFactoryThe TestConfigFactory object for this connection.
Public Property TestCriterionFactoryThe TestCriterionFactory object for this connection.
Public Property TestFactoryThe Test Factory object for this connection.
Public Property TestFolderFactoryThe TestFolderFactory object for this connection.
Public Property TestLabFolderFactoryThe TestLabFolderFactory object for this connection.
Public Property TestRepositoryThe path of the tests directory of the connected project.
Public Property TestSetFactoryThe Test Set Factory object for this connection.
Public Property TestSetTreeManagerThe TestSetTreeManager object for this connection.
Public Property TreeManagerThe TreeManager object for the system tree.
Public Property TSTestFactoryThe factory that manages test instances in test sets.
Public Property UserAssetFactoryThe UserAssetFactory object for this connection.
Public Property UserGroupsListThe names of the user groups of the currently connected project.
Public Property UserNameThe user connected to the project.
Public Property UserSettingsThe Settings object for the logged-on user.
Public Property UsersListThe names of the users of the currently connected project.
Public Property UsingProgressIndicates if a progress bar is displayed.
Public Property VcsDbRepositoryThe path of the VCS database of the connected project.
Public Property VisibleDomainsThe list of domain names that the current logged in user is permitted to view.
Public Property VisibleProjectsThe list of projects in the specified domain that the current logged in user is allowed to connect to.
See Also