ContentChildrenAndDescendantsApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

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

copyPage({required String id, List<String>? expand, required CopyPageRequest body}) → Future<Content>
Copies a single page and its associated properties, permissions, attachments, and custom contents. The id path parameter refers to the content ID of the page to copy. The target of the page to be copied is defined using the destination in the request body and can be one of the following types.
copyPageHierarchy({required String id, required CopyPageHierarchyRequest body}) → Future<LongTask>
Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the copied page titles.
getContentChildren({required String id, List<String>? expand, int? parentVersion}) → Future<ContentChildren>
Deprecated, use Confluence's v2 API.
getContentChildrenByType({required String id, required String type, List<String>? expand, int? parentVersion, int? start, int? limit}) → Future<ContentArray>
Deprecated, use Confluence's v2 API.
getContentDescendants({required String id, List<String>? expand}) → Future<ContentChildren>
Returns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.
getDescendantsOfType({required String id, required String type, String? depth, List<String>? expand, int? start, int? limit}) → Future<ContentArray>
Returns all descendants of a given type, for a piece of content. This is similar to Get content children by type, except that this method returns child pages at all levels, rather than just the direct child pages.
movePage({required String pageId, required String position, required String targetId}) → Future<Map<String, dynamic>>
Move a page to a new location relative to a target 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