ChangeRequest Class

Object representing a request from the client to pend changes to an item or item wildcard characters.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Server.ChangeRequest

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

Syntax

'Declaration
<ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)> _
Public Class ChangeRequest _
    Implements ICloneable, IRecordable
[ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)]
public class ChangeRequest : ICloneable, 
    IRecordable
[ClassVisibilityAttribute(ClientVisibility::Internal, ClientVisibility::Internal)]
public ref class ChangeRequest : ICloneable, 
    IRecordable
[<ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)>]
type ChangeRequest =  
    class 
        interface ICloneable 
        interface IRecordable 
    end
public class ChangeRequest implements ICloneable, IRecordable

The ChangeRequest type exposes the following members.

Constructors

  Name Description
Public method ChangeRequest

Top

Properties

  Name Description
Public property DeletionId If RequestType is Undelete and there is more than one deleted item with the same repository path, this ID is used to disambiguate them. Otherwise, it should be 0.
Public property Encoding The enocding attribute is a versioned property of a file. This defines the Windows encoding used to represent the data.
Public property ItemSpec Server or local path for the item to add.
Public property ItemType The ItemType is a non-versioned property that may only be set when you are adding an item to the repository. Once an item is a file or folder the Type may not be changed. The client should supply the ItemType on calls to help disambiguate.
Public property LockLevel Specifies the new lock level of the item. If the value "Unchanged" is passed in, the lock level is not changed from the previous pending change.
Public property Properties The properties to pend changes for.
Public property RequestType List of change types being made to the item (see RequestType.)
Public property TargetItem If RequestType is Rename, Branch or Undelete, this specifies the new item being changed. Null otherwise.
Public property TargetItemType If TargetItem is specified, this value can override the server's detection of whether the target is a folder or item (move vs rename).
Public property VersionSpec Version specifier. Optional argument used with RequestType.Branch or .Merge. If specified, the branch/merge is to be started from the given VersionSpec, Otherwise, allow the merge logic to figure it out.

Top

Methods

  Name Description
Public method Clone
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (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.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RecordInformation IRecordable.RecordInformation Record class information for logging.
Public method Reset
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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.Server Namespace