getSchemes method

Future<List<MmScheme>?> getSchemes({
  1. String? scope,
  2. int? page,
  3. int? perPage,
})

Get the schemes.

Get a page of schemes. Use the query parameters to modify the behaviour of this endpoint. ##### Permissions Must have manage_system permission. Minimum server version: 5.0

Parameters:

  • String scope: Limit the results returned to the provided scope, either team or channel.

  • int page: The page to select.

  • int perPage: The number of schemes per page.

Implementation

Future<List<MmScheme>?> getSchemes({
  String? scope,
  int? page,
  int? perPage,
}) async {
  final response = await getSchemesWithHttpInfo(
    scope: scope,
    page: page,
    perPage: perPage,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw MmApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // 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) {
    final responseBody = await _decodeBodyBytes(response);
    return (await apiClient.deserializeAsync(responseBody, 'List<MmScheme>') as List).cast<MmScheme>().toList();
  }
  return null;
}