getChildPages method

Future<MultiEntityResult<ChildPage>> getChildPages({
  1. required int id,
  2. String? cursor,
  3. int? limit,
  4. String? sort,
  5. bool? serializeIdsAsStrings,
})

Returns all child pages for given page id. 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.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned.

Implementation

Future<MultiEntityResult<ChildPage>> getChildPages(
    {required int id,
    String? cursor,
    int? limit,
    String? sort,
    bool? serializeIdsAsStrings}) async {
  return MultiEntityResult.fromJson(
    await _client.send(
      'get',
      'pages/{id}/children',
      pathParameters: {
        'id': '$id',
      },
      queryParameters: {
        if (cursor != null) 'cursor': cursor,
        if (limit != null) 'limit': '$limit',
        if (sort != null) 'sort': sort,
        if (serializeIdsAsStrings != null)
          'serialize-ids-as-strings': '$serializeIdsAsStrings',
      },
    ),
    reviver: (v) => ChildPage.fromJson(v as Map<String, Object?>),
  );
}