Class CommentsApi

Hierarchy

CommentsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CommentsApi(basePath?: string): CommentsApi

- Defined in api/api.ts:37435
Parameters
- Optional basePath: string
Returns CommentsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

addComment

addComment(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemCommentResponse>

- Defined in api/api.ts:37452
Add a comment on a work item.

Parameters
- params: object
  - apiVersion: string
  - body: WorkItemCommentCreateRequest
  - organization: string
  - project: string
  - workItemId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemCommentResponse>

deleteComment

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

- Defined in api/api.ts:37518
Delete a comment on a work item.

Parameters
- params: object
  - apiVersion: string
  - commentId: number
  - organization: string
  - project: string
  - workItemId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemCommentResponse>

getComment

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

- Defined in api/api.ts:37583
Returns a work item comment.

Parameters
- params: object
  - Optional $Expand?: string
  - apiVersion: string
  - commentId: number
  - organization: string
  - project: string
  - workItemId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemCommentResponse>

getCommentsBatch

getCommentsBatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemCommentsResponse>

- Defined in api/api.ts:37652
Returns a list of work item comments by ids.

Parameters
- params: object
  - Optional $Expand?: string
  - apiVersion: string
  - ids: string
  - organization: string
  - project: string
  - workItemId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemCommentsResponse>

updateComment

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

- Defined in api/api.ts:37724
Update a comment on a work item.

Parameters
- params: object
  - apiVersion: string
  - body: WorkItemCommentUpdateRequest
  - commentId: number
  - organization: string
  - project: string
  - workItemId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemCommentResponse>

Generated using TypeDoc