VersionApi 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

VersionApi(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

getAttachmentVersionDetails({required String attachmentId, required int versionNumber}) → Future<DetailedVersion>

Retrieves version details for the specified attachment and version number.

getAttachmentVersions({required String id, String? cursor, int? limit, String? sort}) → Future<MultiEntityResult<AttachmentVersion>>

Returns the versions of specific attachment.

getBlogPostVersionDetails({required int blogpostId, required int versionNumber}) → Future<DetailedVersion>

Retrieves version details for the specified blog post and version number.

getBlogPostVersions({required int id, String? bodyFormat, String? cursor, int? limit, String? sort}) → Future<MultiEntityResult<BlogPostVersion>>

Returns the versions of specific blog post.

getCustomContentVersionDetails({required int customContentId, required int versionNumber}) → Future<DetailedVersion>

Retrieves version details for the specified custom content and version number.

getCustomContentVersions({required int customContentId, String? bodyFormat, String? cursor, int? limit, String? sort}) → Future<MultiEntityResult<CustomContentVersion>>

Returns the versions of specific custom content.

getFooterCommentVersionDetails({required int id, required int versionNumber}) → Future<DetailedVersion>

Retrieves version details for the specified footer comment version.

getFooterCommentVersions({required int id, String? bodyFormat, String? cursor, int? limit, String? sort}) → Future<MultiEntityResult<CommentVersion>>

Retrieves the versions of the specified footer comment.

getInlineCommentVersionDetails({required int id, required int versionNumber}) → Future<DetailedVersion>

Retrieves version details for the specified inline comment version.

getInlineCommentVersions({required int id, String? bodyFormat, String? cursor, int? limit, String? sort}) → Future<MultiEntityResult<CommentVersion>>

Retrieves the versions of the specified inline comment.

getPageVersionDetails({required int pageId, required int versionNumber}) → Future<DetailedVersion>

Retrieves version details for the specified page and version number.

getPageVersions({required int id, String? bodyFormat, String? cursor, int? limit, String? sort}) → Future<MultiEntityResult<PageVersion>>

Returns the versions of specific page.

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