Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PullRequestPropertiesApi

Hierarchy

  • PullRequestPropertiesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getPullRequestProperties

  • getPullRequestProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PropertiesCollection>

  • Get external properties of the pull request.

    Parameters

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

    Returns Promise<PropertiesCollection>

updatePullRequestProperties

  • updatePullRequestProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PropertiesCollection>

  • Create or update pull request external properties. The patch operation can be `add`, `replace` or `remove`. For `add` operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For `replace` operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For `remove` operation, the path cannot be empty. If the path does not exist, no action will be performed.

    Parameters

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

    Returns Promise<PropertiesCollection>

Generated using TypeDoc