Share via


ISession Interface

 

Represent the execution of a charter.

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

Syntax

public interface ISession : ITestRunBase, IIdentifiable<int>, 
    IAttachmentOwner, INotifyPropertyChanged
public interface class ISession : ITestRunBase, IIdentifiable<int>, 
    IAttachmentOwner, INotifyPropertyChanged
type ISession = 
    interface
        interface ITestRunBase
        interface IIdentifiable<int>
        interface IAttachmentOwner
        interface INotifyPropertyChanged
    end
Public Interface ISession
    Inherits ITestRunBase, IIdentifiable(Of Integer), IAttachmentOwner,
    INotifyPropertyChanged

Properties

Name Description
System_CAPS_pubproperty Attachments

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

System_CAPS_pubproperty Bookmarks

Bookmarks created when executing this session.

System_CAPS_pubproperty BuildConfigurationId

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

System_CAPS_pubproperty BuildFlavor

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

System_CAPS_pubproperty BuildNumber

Name of the build.(Inherited from ITestRunBase.)

System_CAPS_pubproperty BuildPlatform

Platform of the build. (Inherited from ITestRunBase.)

System_CAPS_pubproperty BuildUri

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_pubproperty CharterId

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

System_CAPS_pubproperty Comment

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

System_CAPS_pubproperty ComputerName

The computer on which the session was run.

System_CAPS_pubproperty Controller

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

System_CAPS_pubproperty DateCompleted

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

System_CAPS_pubproperty DateCreated

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

System_CAPS_pubproperty DateStarted

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

System_CAPS_pubproperty Duration

Duration of the test session.

System_CAPS_pubproperty FeedbackId

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

System_CAPS_pubproperty Id

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

System_CAPS_pubproperty IsDirty

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

System_CAPS_pubproperty LastUpdated

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

System_CAPS_pubproperty LastUpdatedBy

Last person to update run(Inherited from ITestRunBase.)

System_CAPS_pubproperty LastUpdatedByName

Last person to update run(Inherited from ITestRunBase.)

System_CAPS_pubproperty LinkedWorkItemCount

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

System_CAPS_pubproperty Notes

Notes created when executing the session.

System_CAPS_pubproperty Owner

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

System_CAPS_pubproperty OwnerName

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

System_CAPS_pubproperty OwnerTeamFoundationId

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

System_CAPS_pubproperty Revision

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

System_CAPS_pubproperty Sprint

Sprint in which the session was created.

System_CAPS_pubproperty State

State of the session.

System_CAPS_pubproperty TestConfigurationId

ID of the configuration this session was executed against.

System_CAPS_pubproperty TestConfigurationName

Name of the configuration this session was executed against.

System_CAPS_pubproperty TestEnvironmentId

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

System_CAPS_pubproperty TestPlanId

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_pubproperty TestSettings

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

System_CAPS_pubproperty TestSettingsId

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

System_CAPS_pubproperty Title

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

System_CAPS_pubproperty UserStoryId

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

System_CAPS_pubproperty UserStoryTitle

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.

Methods

Name Description
System_CAPS_pubmethod AssociateWorkItem(WorkItem)

Associates the given work item with this session.

System_CAPS_pubmethod CopyTestSettings(ITestSettings)

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

System_CAPS_pubmethod CreateAttachment(Byte[], Int32, Int32)

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

System_CAPS_pubmethod CreateAttachment(String)

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

System_CAPS_pubmethod CreateAttachment(String, SourceFileAction)

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

System_CAPS_pubmethod CreateBookmark()

Creates a session bookmark.

System_CAPS_pubmethod CreateNote()

Creates a session note.

System_CAPS_pubmethod Delete()

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

System_CAPS_pubmethod DisassociateWorkItem(WorkItem)

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

System_CAPS_pubmethod QueryAssociatedWorkItems()

Retrieves work items associated with this session from the server.

System_CAPS_pubmethod Refresh()

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

System_CAPS_pubmethod Save()

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

System_CAPS_pubmethod Save(Boolean)

Sends updated session information to the server.

Events

Name Description
System_CAPS_pubevent AttachmentUploadCompleted

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

System_CAPS_pubevent PropertyChanged

(Inherited from INotifyPropertyChanged.)

See Also

Microsoft.TeamFoundation.TestManagement.Client Namespace

Return to top