Changeset Class

Represents a set of changes committed to the repository.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.Changeset

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

Syntax

'Declaration
Public NotInheritable Class Changeset
public sealed class Changeset
public ref class Changeset sealed
[<Sealed>]
type Changeset =  class end
public final class Changeset

The Changeset type exposes the following members.

Properties

Name Description
Public property ArtifactUri Gets the artifact uniform resource identifier (URI) that is associated with this changeset.
Public property AssociatedWorkItems Returns a limited set of information about the associated work items with this changeset. This property does not spin up a WorkItemStore. Therefore, it is very quick.
Public property Changes Gets or sets an array of Change objects that make up this changeset.
Public property ChangesetId Gets or sets the ID of this changeset.
Public property CheckinNote Gets or sets the check-in note of the changeset.
Public property Comment Gets or sets the comment of the changeset.
Public property Committer Gets or sets the user who committed this changeset.
Public property CommitterDisplayName Display name of user who committed this change
Public property CreationDate Gets or sets the creation date of this changeset.
Public property Owner Gets or sets the owner of this changeset.
Public property OwnerDisplayName Display name of user who owns this change. May differ from Committer if the change was imported or committed on behalf of another user.
Public property PolicyOverride Gets or sets the policy override information of this changeset.
Public property Properties Gets a read-only collection of properties that is associated with this changeset.
Public property VersionControlServer Gets the repository that contains this changeset.
Public property WorkItems Gets an array of work items that are associated with this changeset.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Creates a user-readable string that describes the relevant properties of this Changeset instance. (Overrides Object.ToString().)
Public method Update Updates the changeset metadata on the server.

Top

Remarks

Represents file and folder revisions, links to related work items, check-in notes, a comment, and policy compliance and system metadata such as owner name and date/time of check-in.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.VersionControl.Client Namespace