Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PullRequestReviewersApi

Hierarchy

  • PullRequestReviewersApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createPullRequestReviewer

  • createPullRequestReviewer(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<IdentityRefWithVote>

  • Add a reviewer to a pull request or cast a vote.

    Parameters

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

    Returns Promise<IdentityRefWithVote>

createPullRequestReviewers

  • Add reviewers to a pull request.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<IdentityRef>
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<IdentityRefWithVote>>

deletePullRequestReviewer

  • deletePullRequestReviewer(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Remove a reviewer from a pull request.

    Parameters

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

    Returns Promise<__type>

getPullRequestReviewer

  • getPullRequestReviewer(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<IdentityRefWithVote>

  • Retrieve information about a particular reviewer on a pull request

    Parameters

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

    Returns Promise<IdentityRefWithVote>

getPullRequestReviewers

  • Retrieve the reviewers for a pull request

    Parameters

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

    Returns Promise<ArrayWrapper<IdentityRefWithVote>>

updatePullRequestReviewers

  • updatePullRequestReviewers(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Reset the votes of multiple reviewers on a pull request. NOTE: This endpoint only supports updating votes, but does not support updating required reviewers (use policy) or display names.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<IdentityRefWithVote>
      • organization: string
      • project: string
      • pullRequestId: number
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

Generated using TypeDoc