GitPullRequest Class

Definition

Namespace:

Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:

Microsoft.TeamFoundation.SourceControl.WebApi.dll

Represents all the data associated with a pull request.

C#

[Microsoft.VisualStudio.Services.WebApi.ServiceEventObject]
[System.Runtime.Serialization.DataContract]
public class GitPullRequest : Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlSecuredObject

Inheritance

Object

VersionControlSecuredObject

GitPullRequest

Attributes

Microsoft.VisualStudio.Services.WebApi.ServiceEventObjectAttribute DataContractAttribute

Constructors

GitPullRequest()

Properties

ArtifactId	A string which uniquely identifies this pull request. To generate an artifact ID for a pull request, use this template: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
AutoCompleteSetBy	If set, auto-complete is enabled for this pull request and this is the identity that enabled it.
ClosedBy	The user who closed the pull request.
ClosedDate	The date when the pull request was closed (completed, abandoned, or merged externally).
CodeReviewId	The code review ID of the pull request. Used internally.
Commits	The commits contained in the pull request.
CompletionOptions	Options which affect how the pull request will be merged when it is completed.
CompletionQueueTime	The most recent date at which the pull request entered the queue to be completed. Used internally.
CreatedBy	The identity of the user who created the pull request.
CreationDate	The date when the pull request was created.
Description	The description of the pull request.
ForkSource	If this is a PR from a fork this will contain information about its source.
Labels	The labels associated with the pull request.
LastMergeCommit	The commit of the most recent pull request merge. If empty, the most recent merge is in progress or was unsuccessful.
LastMergeSourceCommit	The commit at the head of the source branch at the time of the last pull request merge.
LastMergeTargetCommit	The commit at the head of the target branch at the time of the last pull request merge.
Links	Links to other related objects.
MergeFailureMessage	If set, pull request merge failed for this reason.
MergeFailureType	The type of failure (if any) of the pull request merge.
MergeId	The ID of the job used to run the pull request merge. Used internally.
MergeOptions	Options used when the pull request merge runs. These are separate from completion options since completion happens only once and a new merge will run every time the source branch of the pull request changes.
MergeStatus	The current status of the pull request merge.
PullRequestId	The ID of the pull request.
RemoteUrl	Used internally.
Repository	The repository containing the target branch of the pull request.
Reviewers	A list of reviewers on the pull request along with the state of their votes.
SourceRefName	The name of the source branch of the pull request.
Status	The status of the pull request.
SupportsIterations	If true, this pull request supports multiple iterations. Iteration support means individual pushes to the source branch of the pull request can be reviewed and comments left in one iteration will be tracked across future iterations.
TargetRefName	The name of the target branch of the pull request.
Title	The title of the pull request.
Url	Used internally.
WorkItemRefs	Any work item references associated with this pull request.

Methods

SetSecuredObject(ISecuredObject)

Explicit Interface Implementations

ISecuredObject.GetToken()	(Inherited from VersionControlSecuredObject)
ISecuredObject.NamespaceId	(Inherited from VersionControlSecuredObject)
ISecuredObject.RequiredPermissions	(Inherited from VersionControlSecuredObject)

Applies to