getSpaces method

Future<List<Space>> getSpaces({
  1. bool recursive = false,
  2. int? pageSize,
  3. String? cursor,
})

Gets all child spaces of this project.

If recursive is true, the server traverses the entire space tree and returns every descendant in a single RPC—no client-side fan-out. The optional pageSize and cursor mirror the server-side paging semantics. Every result is returned as a high-level Space model.

final spaces = await project.getSpaces();
for (final space in spaces) {
  print(space.path);
}

Implementation

Future<List<Space>> getSpaces({
  bool recursive = false,
  int? pageSize,
  String? cursor,
}) async {
  final spaceResponses = await client.getChildSpaces(
    '/$name',
    recursive: recursive,
    pageSize: pageSize,
    cursor: cursor,
  );
  return spaceResponses.map<Space>((s) => Space(s, client)).toList();
}