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
	Attachments	Gets the collection of attachments.(Inherited from IAttachmentOwner.)
	Bookmarks	Bookmarks created when executing this session.
	BuildConfigurationId	Returns the ID of the build configuration for this run or 0 if no id exists (Inherited from ITestRunBase.)
	BuildFlavor	Build flavor such as 'Release' or 'Debug'. (Inherited from ITestRunBase.)
	BuildNumber	Name of the build.(Inherited from ITestRunBase.)
	BuildPlatform	Platform of the build. (Inherited from ITestRunBase.)
	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.)
	CharterId	The charter ID for which the session was run. 0 for ad hoc session.
	Comment	Comments entered by those analyzing the run.(Inherited from ITestRunBase.)
	ComputerName	The computer on which the session was run.
	Controller	The name of the controller of this run(Inherited from ITestRunBase.)
	DateCompleted	Date the last test completed.(Inherited from ITestRunBase.)
	DateCreated	Date the run was created.(Inherited from ITestRunBase.)
	DateStarted	Date the run was started.(Inherited from ITestRunBase.)
	Duration	Duration of the test session.
	FeedbackId	The feedback ID for which the session was run. 0 if the session is not created for feedback.
	Id	Gets the identifier.(Inherited from IIdentifiable<TKey>.)
	IsDirty	Returns true if the test run has been changed since the last Save().(Inherited from ITestRunBase.)
	LastUpdated	Date the run was last modified (title or owner set).(Inherited from ITestRunBase.)
	LastUpdatedBy	Last person to update run(Inherited from ITestRunBase.)
	LastUpdatedByName	Last person to update run(Inherited from ITestRunBase.)
	LinkedWorkItemCount	The total number of bugs associated with the test results.(Inherited from ITestRunBase.)
	Notes	Notes created when executing the session.
	Owner	User who started the run.(Inherited from ITestRunBase.)
	OwnerName	User who started the run.(Inherited from ITestRunBase.)
	OwnerTeamFoundationId	User who started the run.(Inherited from ITestRunBase.)
	Revision	Revision number of TestRun for concurrency control(Inherited from ITestRunBase.)
	Sprint	Sprint in which the session was created.
	State	State of the session.
	TestConfigurationId	ID of the configuration this session was executed against.
	TestConfigurationName	Name of the configuration this session was executed against.
	TestEnvironmentId	The test environment for this run(Inherited from ITestRunBase.)
	TestPlanId	Returns the ID of the test plan that contains this run or 0 if this is an ad-hoc run.(Inherited from ITestRunBase.)
	TestSettings	The test settings being used for this test run execution. Null if the run has no test settings.(Inherited from ITestRunBase.)
	TestSettingsId	ID of the public test settings being used for this test run.(Inherited from ITestRunBase.)
	Title	Title of the associated run template.(Inherited from ITestRunBase.)
	UserStoryId	The user story ID for which the session was run. 0 for ad hoc session.
	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
	AssociateWorkItem(WorkItem)	Associates the given work item with this session.
	CopyTestSettings(ITestSettings)	Copy the test settings and associate it to the test run.(Inherited from ITestRunBase.)
	CreateAttachment(Byte[], Int32, Int32)	Creates an attachment for a Test Result from a byte array.(Inherited from ITestRunBase.)
	CreateAttachment(String)	Creates an attachment from a file. (Inherited from IAttachmentOwner.)
	CreateAttachment(String, SourceFileAction)	Creates an attachment from a file, optionally deleting the source file after uploading.(Inherited from IAttachmentOwner.)
	CreateBookmark()	Creates a session bookmark.
	CreateNote()	Creates a session note.
	Delete()	Removes the given test run and its results from the server.(Inherited from ITestRunBase.)
	DisassociateWorkItem(WorkItem)	Removes the association of the given work item from this test result.
	QueryAssociatedWorkItems()	Retrieves work items associated with this session from the server.
	Refresh()	Updates the run with new data from the server.(Inherited from ITestRunBase.)
	Save()	Writes the new or updated test run to the server.(Inherited from ITestRunBase.)
	Save(Boolean)	Sends updated session information to the server.

Events

	Name	Description
	AttachmentUploadCompleted	This event is raised when the attachment upload is completed.(Inherited from IAttachmentOwner.)
	PropertyChanged	(Inherited from INotifyPropertyChanged.)

See Also

Microsoft.TeamFoundation.TestManagement.Client Namespace

Return to top