listUsersBy method

Future<PaginatedListUserDto?> listUsersBy({
  1. String? startKey,
  2. String? startDocumentId,
  3. int? limit,
})

List users with(out) pagination

Returns a list of users.

Parameters:

  • String startKey: An user email

  • String startDocumentId: An user document ID

  • int limit: Number of rows

Implementation

Future<PaginatedListUserDto?> listUsersBy({ String? startKey, String? startDocumentId, int? limit, }) async {
  final response = await listUsersByWithHttpInfo( startKey: startKey, startDocumentId: startDocumentId, limit: limit, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException.withRequestId(response.statusCode, await _decodeBodyBytes(response), response.headers["x-request-id"], response.request?.url.toString());
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PaginatedListUserDto',) as PaginatedListUserDto;

  }
  return null;
}