Class PullRequestLabelsApi

Hierarchy

PullRequestLabelsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PullRequestLabelsApi(basePath?: string): PullRequestLabelsApi

- Defined in api/api.ts:58736
Parameters
- Optional basePath: string
Returns PullRequestLabelsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createPullRequestLabel

createPullRequestLabel(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WebApiTagDefinition>

- Defined in api/api.ts:58755
Create a label for a specified pull request. The only required field is the name of the new label.

Parameters
- params: object
  - apiVersion: string
  - body: WebApiCreateTagRequestData
  - organization: string
  - project: string
  - Optional projectId?: string
  - pullRequestId: number
  - repositoryId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WebApiTagDefinition>

deletePullRequestLabels

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

- Defined in api/api.ts:58832
Removes a label from the set of those assigned to the pull request.

Parameters
- params: object
  - apiVersion: string
  - labelIdOrName: string
  - organization: string
  - project: string
  - Optional projectId?: string
  - pullRequestId: number
  - repositoryId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getPullRequestLabel

getPullRequestLabel(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WebApiTagDefinition>

- Defined in api/api.ts:58907
Retrieves a single label that has been assigned to a pull request.

Parameters
- params: object
  - apiVersion: string
  - labelIdOrName: string
  - organization: string
  - project: string
  - Optional projectId?: string
  - pullRequestId: number
  - repositoryId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WebApiTagDefinition>

getPullRequestLabels

getPullRequestLabels(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WebApiTagDefinition>>

- Defined in api/api.ts:58981
Get all the labels assigned to a pull request.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - project: string
  - Optional projectId?: string
  - pullRequestId: number
  - repositoryId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<WebApiTagDefinition>>

Generated using TypeDoc