CheckinEvent Class

Artikel
07/02/2014

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.

Inheritance Hierarchy

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)

Syntax

'Declaration
Public Class CheckinEvent _
    Inherits NotificationEvent _
    Implements ICloneable

public class CheckinEvent : NotificationEvent, 
    ICloneable

public ref class CheckinEvent : public NotificationEvent, 
    ICloneable

type CheckinEvent =  
    class 
        inherit NotificationEvent 
        interface ICloneable 
    end

public class CheckinEvent extends NotificationEvent implements ICloneable

The CheckinEvent type exposes the following members.

Constructors

	Name	Description
	CheckinEvent()
	CheckinEvent(Int32, DateTime)	Construct an object by using a changeset number and the date/time the changeset was created.
	CheckinEvent(Int32, DateTime, String, String, String)	Construct an object by using check-in values.
	CheckinEvent(Int32, DateTime, String, String, String, String, String)	Construct an object by using check-in values.

Top

Properties

	Name	Description
	ChangesetCreationDate
	Comment	(Inherited from NotificationEvent.)
	Committer	Return the committer associated with the checkin event. The committer is the identity that submitted the checkin.
	CommitterDisplay	Return the committer associated with the checkin event's display name. The committer is the identity that submitted the checkin.
	ContentTitle	The content title.
	CreationDate	(Inherited from NotificationEvent.)
	Number	Returns the changeset identifier.
	Owner	Returns 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.)
	OwnerDisplay	Returns 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.)
	PolicyOverrideComment	Policy override information for the checkin. (Inherited from NotificationEvent.)
	TeamProject	The team project(s) represented in this event. (Inherited from NotificationEvent.)
	TimeZone	Returns the name of the caller's local time. (Inherited from NotificationEvent.)
	TimeZoneOffset	Returns the offset, from GMT, of the caller's local time. (Inherited from NotificationEvent.)
	Title	Return the title of the checkin event.

Top

Methods

	Name	Description
	Clone	Perform a deep copy of a CheckinEvent object.
	CommentText	Returns a comment string that is less than or equal to maxCommentChars. (Inherited from NotificationEvent.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	AllChangesIncluded	Indicates whether the included changes have been limited because of resource controls. (Inherited from NotificationEvent.)
	Artifacts	A set of related artifacts. (Inherited from NotificationEvent.)
	CheckinInformation	More information communicated at checkin time. (Inherited from NotificationEvent.)
	CheckinNotes	(Optional) Checkin notes for the checkin. (Inherited from NotificationEvent.)
	Notice	For display purposes and may be null. Contains important information that relates to the checkin display process. (Inherited from NotificationEvent.)
	PolicyFailures	Policy failure information for the checkin.
	Subscriber	When 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

Remarks

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

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.

Delen via