WorkspaceCheckInParameters Class

Represents the information that is required to check in pending changes located in a workspace.


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

public class WorkspaceCheckInParameters : CheckInParameters

The WorkspaceCheckInParameters type exposes the following members.

Public methodWorkspaceCheckInParameters(ItemSpec[], String)Initializes a new WorkspaceCheckInParameters instance.
Public methodWorkspaceCheckInParameters(IEnumerable<PendingChange>, String)Initializes a new WorkspaceCheckInParameters instance.

Public propertyAllowUnchangedContentGets or sets a flag describing whether the server will permit a check-in of unchanged content. (Inherited from CheckInParameters.)
Public propertyAssociatedWorkItemsGets or sets the work items associated with this check-in.
Public propertyAuthorGets or sets the author of the check-in. (Inherited from CheckInParameters.)
Public propertyCheckinDateOptionally, the checkin date to use for the checkin. It must be between the date of the last committed checkin and the current server time.
Public propertyCheckinNotesGets or sets the check-in note describing this check-in.
Public propertyCommentGets or sets a comment about the check-in.
Public propertyItemSpecsGets the array of items to check-in.
Public propertyNoAutoResolvePrevents the client from trying to auto resolve conflicts generated by the checkin. (Inherited from CheckInParameters.)
Public propertyNoConflictsCheckForGatedCheckinThis flag only affects the server's behavior when the server paths being checked in affect a gated build definition. In this case the server will ordinarily call CheckPendingChanges before shelving the workspace and throwing back a GatedCheckinException. If the call to CheckPendingChanges creates conflicts, then no GatedCheckinException will be thrown; instead CheckIn fails and informs the user that they must resolve their conflicts. If this flag is specified, this call to CheckPendingChanges is skipped. This allows the gated checkin shelveset to be created even when the items being checked in are not at latest, for example. The build agent workspace will unshelve the shelveset and attempt to resolve conflicts at that time. This is a liberalization of the default behavior. Therefore, the default value for this flag is false.
Public propertyOverrideGatedCheckInGets or sets a flag describing whether to override a gated check-in. (Inherited from CheckInParameters.)
Public propertyPendingChangesGets the enumerable collection of pending changes to check-in.
Public propertyPolicyOverrideGets or sets the policy override information.
Public propertyQueueBuildForGatedCheckInGets or sets a flag describing whether to queue the build for a gated check-in. (Inherited from CheckInParameters.)
Public propertySuppressEventGets or sets a flag describing whether to suppress events. (Inherited from CheckInParameters.)
Public propertyValidateAuthorGets or sets a flag describing whether to validate the author property. (Inherited from CheckInParameters.)

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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