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

'Declaration
Public Interface ISession _
    Inherits ITestRunBase, IIdentifiable(Of Integer), IAttachmentOwner,  _
    INotifyPropertyChanged
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 extends ITestRunBase, IIdentifiable<int>, IAttachmentOwner, INotifyPropertyChanged

The ISession type exposes the following members.

Properties

  Name Description
Public property Attachments Gets the collection of attachments. (Inherited from IAttachmentOwner.)
Public property Bookmarks Bookmarks created when executing this session.
Public property BuildConfigurationId (Inherited from ITestRunBase.)
Public property BuildFlavor (Inherited from ITestRunBase.)
Public property BuildNumber Name of the build. (Inherited from ITestRunBase.)
Public property BuildPlatform (Inherited from ITestRunBase.)
Public property 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.)
Public property CharterId The charter ID for which the session was run. 0 for ad hoc session.
Public property Comment Comments entered by those analyzing the run. (Inherited from ITestRunBase.)
Public property ComputerName The computer on which the session was run.
Public property Controller The name of the controller of this run (Inherited from ITestRunBase.)
Public property DateCompleted Date the last test completed. (Inherited from ITestRunBase.)
Public property DateCreated Date the run was created. (Inherited from ITestRunBase.)
Public property DateStarted Date the run was started. (Inherited from ITestRunBase.)
Public property Duration Duration of the test session.
Public property FeedbackId The feedback ID for which the session was run. 0 if the session is not created for feedback.
Public property Id Gets the identifier. (Inherited from IIdentifiable<TKey>.)
Public property IsDirty Returns true if the test run has been changed since the last Save(). (Inherited from ITestRunBase.)
Public property LastUpdated Date the run was last modified (title or owner set). (Inherited from ITestRunBase.)
Public property LastUpdatedBy Last person to update run (Inherited from ITestRunBase.)
Public property LastUpdatedByName Last person to update run (Inherited from ITestRunBase.)
Public property LinkedWorkItemCount The total number of bugs associated with the test results. (Inherited from ITestRunBase.)
Public property Notes Notes created when executing the session.
Public property Owner User who started the run. (Inherited from ITestRunBase.)
Public property OwnerName User who started the run. (Inherited from ITestRunBase.)
Public property OwnerTeamFoundationId User who started the run. (Inherited from ITestRunBase.)
Public property Revision Revision number of TestRun for concurrency control (Inherited from ITestRunBase.)
Public property Sprint Sprint in which the session was created.
Public property State State of the session.
Public property TestConfigurationId ID of the configuration this session was executed against.
Public property TestConfigurationName Name of the configuration this session was executed against.
Public property TestEnvironmentId The test environment for this run (Inherited from ITestRunBase.)
Public property TestPlanId Returns the ID of the test plan that contains this run or 0 if this is an ad-hoc run. (Inherited from ITestRunBase.)
Public property TestSettings The test settings being used for this test run execution. Null if the run has no test settings. (Inherited from ITestRunBase.)
Public property TestSettingsId ID of the public test settings being used for this test run. (Inherited from ITestRunBase.)
Public property Title Title of the associated run template. (Inherited from ITestRunBase.)
Public property UserStoryId The user story ID for which the session was run. 0 for ad hoc session.
Public property 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.

Top

Methods

  Name Description
Public method AssociateWorkItem Associates the given work item with this session.
Public method CopyTestSettings Copy the test settings and associate it to the test run. (Inherited from ITestRunBase.)
Public method CreateAttachment(String) Creates an attachment from a file. (Inherited from IAttachmentOwner.)
Public method CreateAttachment(String, SourceFileAction) Creates an attachment from a file, optionally deleting the source file after uploading. (Inherited from IAttachmentOwner.)
Public method CreateAttachment(array<Byte[], Int32, Int32) Creates an attachment for a Test Result from a byte array. (Inherited from ITestRunBase.)
Public method CreateBookmark Creates a session bookmark.
Public method CreateNote Creates a session note.
Public method Delete Removes the given test run and its results from the server. (Inherited from ITestRunBase.)
Public method DisassociateWorkItem Removes the association of the given work item from this test result.
Public method QueryAssociatedWorkItems Retrieves work items associated with this session from the server.
Public method Refresh Updates the run with new data from the server. (Inherited from ITestRunBase.)
Public method Save() Writes the new or updated test run to the server. (Inherited from ITestRunBase.)
Public method Save(Boolean) Sends updated session information to the server.

Top

Events

  Name Description
Public event AttachmentUploadCompleted This event is raised when the attachment upload is completed. (Inherited from IAttachmentOwner.)
Public event PropertyChanged Occurs when a property value changes. (Inherited from INotifyPropertyChanged.)

Top

See Also

Reference

Microsoft.TeamFoundation.TestManagement.Client Namespace