Comment class

A comment is displayed within the editor or the Comments Panel, depending on how it is provided.

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

Comment.new({Object? body, CommentMode? mode, CommentAuthorInformation? author, String? contextValue, List<CommentReaction>? reactions, String? label, DateTime? timestamp})
factory

Properties

author ↔ CommentAuthorInformation

Available on Comment, provided by the Comment$Typings extension

The {@link CommentAuthorInformation author information} of the comment
getter/setter pair
body ↔ Object

Available on Comment, provided by the Comment$Typings extension

The human-readable comment body
getter/setter pair
contextValue ↔ String?

Available on Comment, provided by the Comment$Typings extension

Context value of the comment. This can be used to contribute comment specific actions. For example, a comment is given a context value as editable. When contributing actions to comments/comment/title using menus extension point, you can specify context value for key comment in when expression like comment == editable.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
label ↔ String?

Available on Comment, provided by the Comment$Typings extension

Optional label describing the {@link Comment} Label will be rendered next to authorName if exists.
getter/setter pair
mode ↔ CommentMode

Available on Comment, provided by the Comment$Typings extension

{@link CommentMode Comment mode} of the comment
getter/setter pair
reactions ↔ List<CommentReaction>?

Available on Comment, provided by the Comment$Typings extension

Optional reactions of the {@link Comment}
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timestamp ↔ DateTime?

Available on Comment, provided by the Comment$Typings extension

Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited