GitPullRequest interface

包:

azure-devops-extension-api

表示与拉取请求关联的所有数据。

属性

artifactId	唯一标识此拉取请求的字符串。 若要为拉取请求生成项目 ID，请使用以下模板：vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	如果设置，则为此拉取请求启用自动完成，这是启用它的标识。
closedBy	关闭拉取请求的用户。
closedDate	关闭拉取请求 (完成、放弃或在外部) 合并的日期。
codeReviewId	拉取请求的代码评审 ID。 内部使用。
commits	拉取请求中包含的提交。
completionOptions	影响拉取请求在完成时合并方式的选项。
completionQueueTime	拉取请求进入要完成的队列的最近日期。 内部使用。
createdBy	创建拉取请求的用户的标识。
creationDate	创建拉取请求的日期。
description	拉取请求的说明。
forkSource	如果这是来自分叉的 PR，则包含有关其源的信息。
hasMultipleMergeBases	多个合并数据库警告
isDraft	草稿/WIP 拉取请求。
labels	与拉取请求关联的标签。
lastMergeCommit	最近拉取请求合并的提交。 如果为空，则最近的合并正在进行或未成功。
lastMergeSourceCommit	上次拉取请求合并时源分支头处的提交。
lastMergeTargetCommit	上次拉取请求合并时目标分支头处的提交。
mergeFailureMessage	如果已设置，拉取请求合并失败。
mergeFailureType	如果拉取请求合并有任何) ，则 (失败的类型。
mergeId	用于运行拉取请求合并的作业的 ID。 内部使用。
mergeOptions	运行拉取请求合并时使用的选项。 这些选项与完成选项不同，因为完成仅发生一次，并且每次拉取请求的源分支更改时都会运行新的合并。
mergeStatus	拉取请求合并的当前状态。
pullRequestId	拉取请求的 ID。
remoteUrl	内部使用。
repository	包含拉取请求的目标分支的存储库。
reviewers	拉取请求的审阅者列表及其投票状态。
sourceRefName	拉取请求的源分支的名称。
status	拉取请求的状态。
supportsIterations	如果为 true，则此拉取请求支持多次迭代。 迭代支持意味着可以查看对拉取请求源分支的单个推送，并且将在将来的迭代中跟踪一次迭代中留下的注释。
targetRefName	拉取请求的目标分支的名称。
title	拉取请求的标题。
url	内部使用。
workItemRefs	与此拉取请求关联的任何工作项引用。

属性详细信息

artifactId

唯一标识此拉取请求的字符串。 若要为拉取请求生成项目 ID，请使用以下模板：vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

属性值

string

autoCompleteSetBy

如果设置，则为此拉取请求启用自动完成，这是启用它的标识。

autoCompleteSetBy: IdentityRef

属性值

IdentityRef

closedBy

关闭拉取请求的用户。

closedBy: IdentityRef

属性值

IdentityRef

closedDate

关闭拉取请求 (完成、放弃或在外部) 合并的日期。

closedDate: Date

属性值

Date

codeReviewId

拉取请求的代码评审 ID。 内部使用。

codeReviewId: number

属性值

number

commits

拉取请求中包含的提交。

commits: GitCommitRef[]

属性值

GitCommitRef[]

completionOptions

影响拉取请求在完成时合并方式的选项。

completionOptions: GitPullRequestCompletionOptions

属性值

GitPullRequestCompletionOptions

completionQueueTime

拉取请求进入要完成的队列的最近日期。 内部使用。

completionQueueTime: Date

属性值

Date

createdBy

创建拉取请求的用户的标识。

createdBy: IdentityRef

属性值

IdentityRef

creationDate

创建拉取请求的日期。

creationDate: Date

属性值

Date

description

拉取请求的说明。

description: string

属性值

string

forkSource

如果这是来自分叉的 PR，则包含有关其源的信息。

forkSource: GitForkRef

属性值

GitForkRef

hasMultipleMergeBases

多个合并数据库警告

hasMultipleMergeBases: boolean

属性值

boolean

isDraft

草稿/WIP 拉取请求。

isDraft: boolean

属性值

boolean

labels

与拉取请求关联的标签。

labels: WebApiTagDefinition[]

属性值

WebApiTagDefinition[]

lastMergeCommit

最近拉取请求合并的提交。 如果为空，则最近的合并正在进行或未成功。

lastMergeCommit: GitCommitRef

属性值

GitCommitRef

lastMergeSourceCommit

上次拉取请求合并时源分支头处的提交。

lastMergeSourceCommit: GitCommitRef

属性值

GitCommitRef

lastMergeTargetCommit

上次拉取请求合并时目标分支头处的提交。

lastMergeTargetCommit: GitCommitRef

属性值

GitCommitRef

mergeFailureMessage

如果已设置，拉取请求合并失败。

mergeFailureMessage: string

属性值

string

mergeFailureType

如果拉取请求合并有任何) ，则 (失败的类型。

mergeFailureType: PullRequestMergeFailureType

属性值

PullRequestMergeFailureType

mergeId

用于运行拉取请求合并的作业的 ID。 内部使用。

mergeId: string

属性值

string

mergeOptions

运行拉取请求合并时使用的选项。 这些选项与完成选项不同，因为完成仅发生一次，并且每次拉取请求的源分支更改时都会运行新的合并。

mergeOptions: GitPullRequestMergeOptions

属性值

GitPullRequestMergeOptions

mergeStatus

拉取请求合并的当前状态。

mergeStatus: PullRequestAsyncStatus

属性值

PullRequestAsyncStatus

pullRequestId

拉取请求的 ID。

pullRequestId: number

属性值

number

remoteUrl

内部使用。

remoteUrl: string

属性值

string

repository

包含拉取请求的目标分支的存储库。

repository: GitRepository

属性值

GitRepository

reviewers

拉取请求的审阅者列表及其投票状态。

reviewers: IdentityRefWithVote[]

属性值

IdentityRefWithVote[]

sourceRefName

拉取请求的源分支的名称。

sourceRefName: string

属性值

string

status

拉取请求的状态。

status: PullRequestStatus

属性值

PullRequestStatus

supportsIterations

如果为 true，则此拉取请求支持多次迭代。 迭代支持意味着可以查看对拉取请求源分支的单个推送，并且将在将来的迭代中跟踪一次迭代中留下的注释。

supportsIterations: boolean

属性值

boolean

targetRefName

拉取请求的目标分支的名称。

targetRefName: string

属性值

string

title

拉取请求的标题。

title: string

属性值

string

url

内部使用。

url: string

属性值

string

workItemRefs

与此拉取请求关联的任何工作项引用。

workItemRefs: ResourceRef[]

属性值

ResourceRef[]