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
	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	(Inherited from ITestRunBase.)
	BuildPlatform	Platform of the build. (Inherited from ITestRunBase.)
	BuildUri	(Inherited from ITestRunBase.)
	CharterId	The charter ID for which the session was run. 0 for ad hoc session.
	Comment	(Inherited from ITestRunBase.)
	ComputerName	The computer on which the session was run.
	Controller	(Inherited from ITestRunBase.)
	DateCompleted	(Inherited from ITestRunBase.)
	DateCreated	(Inherited from ITestRunBase.)
	DateStarted	(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	(Inherited from ITestRunBase.)
	LastUpdated	(Inherited from ITestRunBase.)
	LastUpdatedBy	(Inherited from ITestRunBase.)
	LastUpdatedByName	(Inherited from ITestRunBase.)
	LinkedWorkItemCount	(Inherited from ITestRunBase.)
	Notes	Notes created when executing the session.
	Owner	(Inherited from ITestRunBase.)
	OwnerName	(Inherited from ITestRunBase.)
	OwnerTeamFoundationId	(Inherited from ITestRunBase.)
	Revision	(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	(Inherited from ITestRunBase.)
	TestPlanId	(Inherited from ITestRunBase.)
	TestSettings	(Inherited from ITestRunBase.)
	TestSettingsId	(Inherited from ITestRunBase.)
	Title	(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.

Top

Methods

	Name	Description
	AssociateWorkItem	Associates the given work item with this session.
	CopyTestSettings	(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.)
	CreateAttachment(array<Byte[], Int32, Int32)	(Inherited from ITestRunBase.)
	CreateBookmark	Creates a session bookmark.
	CreateNote	Creates a session note.
	Delete	(Inherited from ITestRunBase.)
	DisassociateWorkItem	Removes the association of the given work item from this test result.
	QueryAssociatedWorkItems	Retrieves work items associated with this session from the server.
	Refresh	(Inherited from ITestRunBase.)
	Save()	(Inherited from ITestRunBase.)
	Save(Boolean)	Sends updated session information to the server.

Top

Events

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

Top

See Also

Reference

Microsoft.TeamFoundation.TestManagement.Client Namespace