CommentApi class

This document describes Confluence's v2 APIs. This is intended to be an iteration on the existing Confluence Cloud REST API with improvements in both endpoint definitions and performance.

Constructors

CommentApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createFooterComment({bool? serializeIdsAsStrings, required CreateFooterCommentModel body}) → Future<FooterCommentModel>

Create a footer comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body).

createInlineComment({bool? serializeIdsAsStrings, required CreateInlineCommentModel body}) → Future<InlineCommentModel>

Create an inline comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body). Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence.

deleteFooterComment(int commentId) → Future<void>

Deletes a footer comment. This is a permanent deletion and cannot be reverted.

deleteInlineComment(int commentId) → Future<void>

Deletes an inline comment. This is a permanent deletion and cannot be reverted.

getBlogPostFooterComments({required int id, String? bodyFormat, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<BlogPostCommentModel>>

Returns the root footer comments of specific blog post. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getBlogPostInlineComments({required int id, String? bodyFormat, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<BlogPostInlineCommentModel>>

Returns the root inline comments of specific blog post. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getFooterCommentById({required int commentId, String? bodyFormat, int? version, bool? serializeIdsAsStrings}) → Future<FooterCommentModel>

Retrieves a footer comment by id

getFooterCommentChildren({required int id, String? bodyFormat, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<ChildrenCommentModel>>

Returns the children footer comments of specific comment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getFooterComments({String? bodyFormat, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<InlineCommentModel>>

Returns all footer comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getInlineCommentById({required int commentId, String? bodyFormat, int? version, bool? serializeIdsAsStrings}) → Future<InlineCommentModel>

Retrieves an inline comment by id

getInlineCommentChildren({required int id, bool? serializeIdsAsStrings, String? bodyFormat, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<InlineCommentChildrenModel>>

Returns the children inline comments of specific comment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getInlineComments({bool? serializeIdsAsStrings, String? bodyFormat, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<InlineCommentModel>>

Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getPageFooterComments({required int id, String? bodyFormat, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<PageCommentModel>>

Returns the root footer comments of specific page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

getPageInlineComments({required int id, String? bodyFormat, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<PageInlineCommentModel>>

Returns the root inline comments of specific page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateFooterComment({required int commentId, bool? serializeIdsAsStrings, required UpdateFooterCommentModel body}) → Future<FooterCommentModel>

Update a footer comment. This can be used to update the body text of a comment.

updateInlineComment({required int commentId, bool? serializeIdsAsStrings, required UpdateInlineCommentModel body}) → Future<InlineCommentModel>

Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment

Operators

operator ==(Object other) → bool

The equality operator.

inherited