Interface Comment

Comment on a Work Item.

interface Comment {
    _links?: any;
    createdBy?: IdentityRef;
    createdDate?: Date;
    createdOnBehalfDate?: Date;
    createdOnBehalfOf?: IdentityRef;
    format?: CommentFormat;
    id?: number;
    isDeleted?: boolean;
    mentions?: CommentMention[];
    modifiedBy?: IdentityRef;
    modifiedDate?: Date;
    reactions?: CommentReaction[];
    renderedText?: string;
    text?: string;
    url?: string;
    version?: number;
    workItemId?: number;
}

Hierarchy (View Summary)

Properties

_links? createdBy? createdDate? createdOnBehalfDate? createdOnBehalfOf? format? id? isDeleted? mentions? modifiedBy? modifiedDate? reactions? renderedText? text? url? version? workItemId?

Properties

Optional_links

_links?: any

Link references to related REST resources.

OptionalcreatedBy

createdBy?: IdentityRef

IdentityRef of the creator of the comment.

OptionalcreatedDate

createdDate?: Date

The creation date of the comment.

OptionalcreatedOnBehalfDate

createdOnBehalfDate?: Date

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

OptionalcreatedOnBehalfOf

createdOnBehalfOf?: IdentityRef

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

Optionalformat

format?: CommentFormat

Represents the possible types for the comment format.

Optionalid

id?: number

The id assigned to the comment.

OptionalisDeleted

isDeleted?: boolean

Indicates if the comment has been deleted.

Optionalmentions

mentions?: CommentMention[]

The mentions of the comment.

OptionalmodifiedBy

modifiedBy?: IdentityRef

IdentityRef of the user who last modified the comment.

OptionalmodifiedDate

modifiedDate?: Date

The last modification date of the comment.

Optionalreactions

reactions?: CommentReaction[]

The reactions of the comment.

OptionalrenderedText

renderedText?: string

The text of the comment in HTML format.

Optionaltext

text?: string

The text of the comment.

Optionalurl

url?: string

REST URL for the resource.

Optionalversion

version?: number

The current version of the comment.

OptionalworkItemId

workItemId?: number

The id of the work item this comment belongs to.

Settings

Member Visibility

On This Page

Properties