getPagesInSpace method

Future<MultiEntityResult<PageBulk>> getPagesInSpace({ required int id, String? depth, String? sort, List<String>? status, String? title, String? bodyFormat, String? cursor, int? limit, bool? serializeIdsAsStrings, })

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.

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

Implementation

Future<MultiEntityResult<PageBulk>> getPagesInSpace(
    {required int id,
    String? depth,
    String? sort,
    List<String>? status,
    String? title,
    String? bodyFormat,
    String? cursor,
    int? limit,
    bool? serializeIdsAsStrings}) async {
  return MultiEntityResult.fromJson(
    await _client.send(
      'get',
      'spaces/{id}/pages',
      pathParameters: {
        'id': '$id',
      },
      queryParameters: {
        if (depth != null) 'depth': depth,
        if (sort != null) 'sort': sort,
        if (status != null) 'status': status.map((e) => e).join(','),
        if (title != null) 'title': title,
        if (bodyFormat != null) 'body-format': bodyFormat,
        if (cursor != null) 'cursor': cursor,
        if (limit != null) 'limit': '$limit',
        if (serializeIdsAsStrings != null)
          'serialize-ids-as-strings': '$serializeIdsAsStrings',
      },
    ),
    reviver: (v) => PageBulk.fromJson(v as Map<String, Object?>),
  );
}