Class PullRequestThreadCommentsApi

Hierarchy

PullRequestThreadCommentsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PullRequestThreadCommentsApi(basePath?: string): PullRequestThreadCommentsApi

- Defined in api/api.ts:60170
Parameters
- Optional basePath: string
Returns PullRequestThreadCommentsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createComment

createComment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Comment>

- Defined in api/api.ts:60189
Create a comment on a specific thread in a pull request (up to 500 comments can be created per thread).

Parameters
- params: object
  - apiVersion: string
  - body: Comment
  - organization: string
  - project: string
  - pullRequestId: number
  - repositoryId: string
  - threadId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Comment>

deleteComment

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

- Defined in api/api.ts:60267
Delete a comment associated with a specific thread in a pull request.

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

getComment

getComment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Comment>

- Defined in api/api.ts:60343
Retrieve a comment associated with a specific thread in a pull request.

Parameters
- params: object
  - apiVersion: string
  - commentId: number
  - organization: string
  - project: string
  - pullRequestId: number
  - repositoryId: string
  - threadId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Comment>

getComments

getComments(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Comment>>

- Defined in api/api.ts:60418
Retrieve all comments associated with a specific thread in a pull request.

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

updateComment

updateComment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Comment>

- Defined in api/api.ts:60490
Update a comment associated with a specific thread in a pull request.

Parameters
- params: object
  - apiVersion: string
  - body: Comment
  - commentId: number
  - organization: string
  - project: string
  - pullRequestId: number
  - repositoryId: string
  - threadId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Comment>

Generated using TypeDoc