This documentation is archived and is not being maintained.

CheckinEvent Class

A checkin event encompasses information about the check-in and also other items, e.g., work items that are related to the check-in.

All check-ins include a changeset, date/time information, owner/committer and a (possibly empty) comment.

System.Object
  Microsoft.TeamFoundation.VersionControl.Common.NotificationEvent
    Microsoft.TeamFoundation.VersionControl.Common.CheckinEvent

Namespace:  Microsoft.TeamFoundation.VersionControl.Common
Assembly:  Microsoft.TeamFoundation.VersionControl.Common.Integration (in Microsoft.TeamFoundation.VersionControl.Common.Integration.dll)

public class CheckinEvent : NotificationEvent, 
	ICloneable

The CheckinEvent type exposes the following members.

  NameDescription
Public methodCheckinEvent()
Public methodCheckinEvent(Int32, DateTime)Construct an object by using a changeset number and the date/time the changeset was created.
Public methodCheckinEvent(Int32, DateTime, String, String, String)Construct an object by using check-in values.
Public methodCheckinEvent(Int32, DateTime, String, String, String, String, String)Construct an object by using check-in values.
Top

  NameDescription
Public propertyChangesetCreationDate
Public propertyComment (Inherited from NotificationEvent.)
Public propertyCommitterReturn the committer associated with the checkin event. The committer is the identity that submitted the checkin.
Public propertyCommitterDisplayReturn the committer associated with the checkin event's display name. The committer is the identity that submitted the checkin.
Public propertyContentTitleThe content title.
Public propertyCreationDate (Inherited from NotificationEvent.)
Public propertyNumberReturns the changeset identifier.
Public propertyOwnerReturns the owner associated with the checkin event. The owner may be different from the committer when a proxy identity performs the checkin. In this case, the owner is the identity for whom the proxy identity performs the checkin. (Inherited from NotificationEvent.)
Public propertyOwnerDisplayReturns the owner associated with the checkin event's display name. The owner may be different from the committer when a proxy identity performs the checkin. In this case, the owner is the identity for whom the proxy identity performs the checkin. (Inherited from NotificationEvent.)
Public propertyPolicyOverrideCommentPolicy override information for the checkin. (Inherited from NotificationEvent.)
Public propertyTeamProjectThe team project(s) represented in this event. (Inherited from NotificationEvent.)
Public propertyTimeZoneReturns the name of the caller's local time. (Inherited from NotificationEvent.)
Public propertyTimeZoneOffsetReturns the offset, from GMT, of the caller's local time. (Inherited from NotificationEvent.)
Public propertyTitleReturn the title of the checkin event.
Top

  NameDescription
Public methodClonePerform a deep copy of a CheckinEvent object.
Protected methodCommentTextReturns a comment string that is less than or equal to maxCommentChars. (Inherited from NotificationEvent.)
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.)
Top

  NameDescription
Public fieldAllChangesIncludedIndicates whether the included changes have been limited because of resource controls. (Inherited from NotificationEvent.)
Public fieldArtifactsA set of related artifacts. (Inherited from NotificationEvent.)
Public fieldCheckinInformationMore information communicated at checkin time. (Inherited from NotificationEvent.)
Public fieldCheckinNotes(Optional) Checkin notes for the checkin. (Inherited from NotificationEvent.)
Public fieldNoticeFor display purposes and may be null. Contains important information that relates to the checkin display process. (Inherited from NotificationEvent.)
Public fieldPolicyFailuresPolicy failure information for the checkin.
Public fieldSubscriberWhen used in the alert process, contains the name of the user who subscribed to the alert. This information can be used by the alert recipient when it is necessary. (Inherited from NotificationEvent.)
Top

Note that a CheckinEvent object is the basis upon which post-checkin alerts are formed.

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