Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PullRequestsApi

Hierarchy

  • PullRequestsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createPullRequest

  • createPullRequest(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPullRequest>

  • Create a pull request.

    Parameters

    • params: object
      • apiVersion: string
      • body: GitPullRequest
      • organization: string
      • project: string
      • repositoryId: string
      • Optional supportsIterations?: boolean
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitPullRequest>

getPullRequest

  • getPullRequest(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPullRequest>

  • Retrieve a pull request.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional includeCommits?: boolean
      • Optional includeWorkItemRefs?: boolean
      • Optional maxCommentLength?: number
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitPullRequest>

getPullRequestById

  • getPullRequestById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPullRequest>

  • Retrieve a pull request.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
      • pullRequestId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitPullRequest>

getPullRequests

  • Retrieve all pull requests matching a specified criteria.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional maxCommentLength?: number
      • organization: string
      • project: string
      • repositoryId: string
      • Optional searchCriteriaCreatorId?: string
      • Optional searchCriteriaIncludeLinks?: boolean
      • Optional searchCriteriaRepositoryId?: string
      • Optional searchCriteriaReviewerId?: string
      • Optional searchCriteriaSourceRefName?: string
      • Optional searchCriteriaSourceRepositoryId?: string
      • Optional searchCriteriaStatus?: string
      • Optional searchCriteriaTargetRefName?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitPullRequest>>

getPullRequestsByProject

  • Retrieve all pull requests matching a specified criteria.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional maxCommentLength?: number
      • organization: string
      • project: string
      • Optional searchCriteriaCreatorId?: string
      • Optional searchCriteriaIncludeLinks?: boolean
      • Optional searchCriteriaRepositoryId?: string
      • Optional searchCriteriaReviewerId?: string
      • Optional searchCriteriaSourceRefName?: string
      • Optional searchCriteriaSourceRepositoryId?: string
      • Optional searchCriteriaStatus?: string
      • Optional searchCriteriaTargetRefName?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitPullRequest>>

updatePullRequest

  • updatePullRequest(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPullRequest>

  • Update a pull request These are the properties that can be updated with the API: - Status - Title - Description (up to 4000 characters) - CompletionOptions - MergeOptions - AutoCompleteSetBy.Id - TargetRefName (when the PR retargeting feature is enabled) Attempting to update other properties outside of this list will either cause the server to throw an `InvalidArgumentValueException`, or to silently ignore the update.

    Parameters

    • params: object
      • apiVersion: string
      • body: GitPullRequest
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitPullRequest>

Generated using TypeDoc