getChildSpaces method

Future<List<SpaceResponse>> getChildSpaces(
  1. String parentPath, {
  2. bool recursive = false,
  3. int? pageSize,
  4. String? cursor,
})
inherited

Lists child spaces under a parent path.

parentPath is the path to list children from. Use an empty string to list root-level spaces. Set recursive to true to include all nested spaces. pageSize and cursor enable pagination; when either is supplied the result is a PagedList exposing nextCursor and totalCount.

Implementation

Future<List<SpaceResponse>> getChildSpaces(
  String parentPath, {
  bool recursive = false,
  int? pageSize,
  String? cursor,
}) async {
  final request = GetChildSpacesRequest()
    ..parentPath = parentPath
    ..recursive = recursive;

  if (pageSize != null || cursor != null) {
    request.pagination = PaginationRequest()
      ..pageSize = pageSize ?? 100
      ..cursor = cursor ?? '';
  }

  final response = await stub.getChildSpaces(request, options: callOptions);

  if (response.hasPagination()) {
    return PagedList(
      response.spaces,
      nextCursor: response.pagination.nextCursor,
      totalCount: response.pagination.totalCount,
    );
  }
  return response.spaces;
}