Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PullRequestStatusesApi

Hierarchy

  • PullRequestStatusesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createPullRequestStatus

  • createPullRequestStatus(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPullRequestStatus>

  • Create a pull request status. The only required field for the status is `Context.Name` that uniquely identifies the status. Note that you can specify iterationId in the request body to post the status on the iteration.

    Parameters

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

    Returns Promise<GitPullRequestStatus>

deletePullRequestStatus

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

  • Delete pull request status. You can remove multiple statuses in one call by using Update operation.

    Parameters

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

    Returns Promise<__type>

getPullRequestStatus

  • getPullRequestStatus(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitPullRequestStatus>

  • Get the specific pull request status by ID. The status ID is unique within the pull request across all iterations.

    Parameters

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

    Returns Promise<GitPullRequestStatus>

getPullRequestStatuses

  • Get all the statuses associated with 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<GitPullRequestStatus>>

updatePullRequestStatuses

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

  • Update pull request statuses collection. The only supported operation type is `remove`. This operation allows to delete multiple statuses in one call. The path of the `remove` operation should refer to the ID of the pull request status. For example `path="/1"` refers to the pull request status with ID 1.

    Parameters

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

    Returns Promise<__type>

Generated using TypeDoc