CommentThread interface

Represents a comment thread of a pull request. A thread contains meta data about the file it was left on along with one or more comments (an initial comment and the subsequent replies).

Properties

comments

A list of the comments.

id

The comment thread id.

identities

Set of identities related to this thread

isDeleted

Specify if the thread is deleted which happens when all comments are deleted.

lastUpdatedDate

The time this thread was last updated.

properties

Optional properties associated with the thread as a collection of key-value pairs.

publishedDate

The time this thread was published.

status

The status of the comment thread.

threadContext

Specify thread context such as position in left/right file.

Property Details

comments

A list of the comments.

comments: Comment[]

Property Value

id

The comment thread id.

id: number

Property Value

number

identities

Set of identities related to this thread

identities: {[key: string]: WebApi.IdentityRef}

Property Value

{[key: string]: IdentityRef}

isDeleted

Specify if the thread is deleted which happens when all comments are deleted.

isDeleted: boolean

Property Value

boolean

lastUpdatedDate

The time this thread was last updated.

lastUpdatedDate: Date

Property Value

Date

properties

Optional properties associated with the thread as a collection of key-value pairs.

properties: any

Property Value

any

publishedDate

The time this thread was published.

publishedDate: Date

Property Value

Date

status

The status of the comment thread.

status: CommentThreadStatus

Property Value

threadContext

Specify thread context such as position in left/right file.

threadContext: CommentThreadContext

Property Value