Comment interface

Package:

azure-devops-extension-api

Comment on a Work Item.

Extends

WorkItemTrackingResource

Properties

createdBy	IdentityRef of the creator of the comment.
createdDate	The creation date of the comment.
createdOnBehalfDate	Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
createdOnBehalfOf	Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
format	Represents the possible types for the comment format.
id	The id assigned to the comment.
isDeleted	Indicates if the comment has been deleted.
mentions	The mentions of the comment.
modifiedBy	IdentityRef of the user who last modified the comment.
modifiedDate	The last modification date of the comment.
reactions	The reactions of the comment.
renderedText	The text of the comment in HTML format.
text	The text of the comment.
version	The current version of the comment.
workItemId	The id of the work item this comment belongs to.

Inherited Properties

url	REST URL for the resource.

Property Details

createdBy

IdentityRef of the creator of the comment.

createdBy: IdentityRef

Property Value

IdentityRef

createdDate

The creation date of the comment.

createdDate: Date

Property Value

Date

createdOnBehalfDate

Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.

createdOnBehalfDate: Date

Property Value

Date

createdOnBehalfOf

Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.

createdOnBehalfOf: IdentityRef

Property Value

IdentityRef

format

Represents the possible types for the comment format.

format: CommentFormat

Property Value

CommentFormat

id

The id assigned to the comment.

id: number

Property Value

number

isDeleted

Indicates if the comment has been deleted.

isDeleted: boolean

Property Value

boolean

mentions

The mentions of the comment.

mentions: CommentMention[]

Property Value

CommentMention[]

modifiedBy

IdentityRef of the user who last modified the comment.

modifiedBy: IdentityRef

Property Value

IdentityRef

modifiedDate

The last modification date of the comment.

modifiedDate: Date

Property Value

Date

reactions

The reactions of the comment.

reactions: CommentReaction[]

Property Value

CommentReaction[]

renderedText

The text of the comment in HTML format.

renderedText: string

Property Value

string

text

The text of the comment.

text: string

Property Value

string

version

The current version of the comment.

version: number

Property Value

number

workItemId

The id of the work item this comment belongs to.

workItemId: number

Property Value

number

Inherited Property Details

url

REST URL for the resource.

url: string

Property Value

string

Inherited From WorkItemTrackingResource.url