Interface Comment

Comment on an artifact like Work Item or Wiki, etc.

interface Comment {
    artifactId?: string;
    createdBy?: IdentityRef;
    createdDate?: Date;
    id?: number;
    isDeleted?: boolean;
    mentions?: CommentMention[];
    modifiedBy?: IdentityRef;
    modifiedDate?: Date;
    parentId?: number;
    reactions?: CommentReaction[];
    renderedText?: string;
    replies?: CommentList;
    state?: CommentState;
    text?: string;
    url?: string;
    version?: number;
}

Hierarchy (View Summary)

Properties

artifactId? createdBy? createdDate? id? isDeleted? mentions? modifiedBy? modifiedDate? parentId? reactions? renderedText? replies? state? text? url? version?

Properties

OptionalartifactId

artifactId?: string

The id of the artifact this comment belongs to

OptionalcreatedBy

createdBy?: IdentityRef

IdentityRef of the creator of the comment.

OptionalcreatedDate

createdDate?: Date

The creation date of the comment.

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.

OptionalparentId

parentId?: number

The comment id of the parent comment, if any

Optionalreactions

reactions?: CommentReaction[]

The reactions on the comment.

OptionalrenderedText

renderedText?: string

The rendered text of the comment

Optionalreplies

replies?: CommentList

Replies for this comment

Optionalstate

state?: CommentState

Indicates the current state of the comment

Optionaltext

text?: string

The plaintext/markdown version of the comment

Optionalurl

url?: string

REST URL for the resource.

Optionalversion

version?: number

The current version of the comment

Settings

Member Visibility

On This Page

Properties