Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ISession Interface

 

Represent the execution of a charter.

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

public interface class ISession : ITestRunBase, IIdentifiable<int>, 
	IAttachmentOwner, INotifyPropertyChanged

NameDescription
System_CAPS_pubpropertyAttachments

Gets the collection of attachments.(Inherited from IAttachmentOwner.)

System_CAPS_pubpropertyBookmarks

Bookmarks created when executing this session.

System_CAPS_pubpropertyBuildConfigurationId

Returns the ID of the build configuration for this run or 0 if no id exists (Inherited from ITestRunBase.)

System_CAPS_pubpropertyBuildFlavor

Build flavor such as 'Release' or 'Debug'. (Inherited from ITestRunBase.)

System_CAPS_pubpropertyBuildNumber

Name of the build.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyBuildPlatform

Platform of the build. (Inherited from ITestRunBase.)

System_CAPS_pubpropertyBuildUri

Name (as a URI) of the build the run was executed against.

As an example: new Uri("vstfs:///Build/Build/1")(Inherited from ITestRunBase.)

System_CAPS_pubpropertyCharterId

The charter ID for which the session was run. 0 for ad hoc session.

System_CAPS_pubpropertyComment

Comments entered by those analyzing the run.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyComputerName

The computer on which the session was run.

System_CAPS_pubpropertyController

The name of the controller of this run(Inherited from ITestRunBase.)

System_CAPS_pubpropertyDateCompleted

Date the last test completed.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyDateCreated

Date the run was created.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyDateStarted

Date the run was started.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyDuration

Duration of the test session.

System_CAPS_pubpropertyFeedbackId

The feedback ID for which the session was run. 0 if the session is not created for feedback.

System_CAPS_pubpropertyId

Gets the identifier.(Inherited from IIdentifiable<TKey>.)

System_CAPS_pubpropertyIsDirty

Returns true if the test run has been changed since the last Save().(Inherited from ITestRunBase.)

System_CAPS_pubpropertyLastUpdated

Date the run was last modified (title or owner set).(Inherited from ITestRunBase.)

System_CAPS_pubpropertyLastUpdatedBy

Last person to update run(Inherited from ITestRunBase.)

System_CAPS_pubpropertyLastUpdatedByName

Last person to update run(Inherited from ITestRunBase.)

System_CAPS_pubpropertyLinkedWorkItemCount

The total number of bugs associated with the test results.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyNotes

Notes created when executing the session.

System_CAPS_pubpropertyOwner

User who started the run.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyOwnerName

User who started the run.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyOwnerTeamFoundationId

User who started the run.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyRevision

Revision number of TestRun for concurrency control(Inherited from ITestRunBase.)

System_CAPS_pubpropertySprint

Sprint in which the session was created.

System_CAPS_pubpropertyState

State of the session.

System_CAPS_pubpropertyTestConfigurationId

ID of the configuration this session was executed against.

System_CAPS_pubpropertyTestConfigurationName

Name of the configuration this session was executed against.

System_CAPS_pubpropertyTestEnvironmentId

The test environment for this run(Inherited from ITestRunBase.)

System_CAPS_pubpropertyTestPlanId

Returns the ID of the test plan that contains this run or 0 if this is an ad-hoc run.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyTestSettings

The test settings being used for this test run execution. Null if the run has no test settings.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyTestSettingsId

ID of the public test settings being used for this test run.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyTitle

Title of the associated run template.(Inherited from ITestRunBase.)

System_CAPS_pubpropertyUserStoryId

The user story ID for which the session was run. 0 for ad hoc session.

System_CAPS_pubpropertyUserStoryTitle

The title of the user story of the session, as of when the session is retrieved from the server.

May be null if the server is of an older version, or if the server is unable to fetch the title.

NameDescription
System_CAPS_pubmethodAssociateWorkItem(WorkItem^)

Associates the given work item with this session.

System_CAPS_pubmethodCopyTestSettings(ITestSettings^)

Copy the test settings and associate it to the test run.(Inherited from ITestRunBase.)

System_CAPS_pubmethodCreateAttachment(array<Byte>^, Int32, Int32)

Creates an attachment for a Test Result from a byte array.(Inherited from ITestRunBase.)

System_CAPS_pubmethodCreateAttachment(String^)

Creates an attachment from a file. (Inherited from IAttachmentOwner.)

System_CAPS_pubmethodCreateAttachment(String^, SourceFileAction)

Creates an attachment from a file, optionally deleting the source file after uploading.(Inherited from IAttachmentOwner.)

System_CAPS_pubmethodCreateBookmark()

Creates a session bookmark.

System_CAPS_pubmethodCreateNote()

Creates a session note.

System_CAPS_pubmethodDelete()

Removes the given test run and its results from the server.(Inherited from ITestRunBase.)

System_CAPS_pubmethodDisassociateWorkItem(WorkItem^)

Removes the association of the given work item from this test result.

System_CAPS_pubmethodQueryAssociatedWorkItems()

Retrieves work items associated with this session from the server.

System_CAPS_pubmethodRefresh()

Updates the run with new data from the server.(Inherited from ITestRunBase.)

System_CAPS_pubmethodSave()

Writes the new or updated test run to the server.(Inherited from ITestRunBase.)

System_CAPS_pubmethodSave(Boolean)

Sends updated session information to the server.

NameDescription
System_CAPS_pubeventAttachmentUploadCompleted

This event is raised when the attachment upload is completed.(Inherited from IAttachmentOwner.)

System_CAPS_pubeventPropertyChanged

(Inherited from INotifyPropertyChanged.)

Return to top
Show: