PageApi 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

PageApi(ApiClient _client)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createPage({bool? embedded, bool? private, required PageCreateRequest body}) → Future<PageSingle>
Creates a page in the space.
deletePage(int id) → Future<void>
Delete a page by id.
getLabelPages({required int id, List<int>? spaceId, String? bodyFormat, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<PageBulk>>
Returns the pages of specified label. 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.
getPageById({required int id, String? bodyFormat, bool? getDraft, int? version}) → Future<PageSingle>
Returns a specific page.
getPages({List<int>? id, List<int>? spaceId, String? sort, List<String>? status, String? title, String? bodyFormat, String? cursor, int? limit}) → Future<MultiEntityResult<PageBulk>>
Returns all pages. 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.
getPagesInSpace({required int id, String? depth, String? sort, List<String>? status, String? title, String? bodyFormat, String? cursor, int? limit}) → Future<MultiEntityResult<PageBulk>>
Returns all pages in a space. 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
updatePage({required int id, required PageUpdateRequest body}) → Future<PageSingle>
Update a page by id.

Operators

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