getGroupsByChannel method

Future<List<MmGroup>?> getGroupsByChannel(String channelId, { int? page, int? perPage, bool? filterAllowReference, })

Get channel groups

Retrieve the list of groups associated with a given channel. ##### Permissions Must have manage_system permission. Minimum server version: 5.11

Parameters:

• String channelId (required): Channel GUID

• int page: The page to select.

• int perPage: The number of groups per page.

• bool filterAllowReference: Boolean which filters the group entries with the allow_reference attribute set.

Implementation

Future<List<MmGroup>?> getGroupsByChannel(
  String channelId, {
  int? page,
  int? perPage,
  bool? filterAllowReference,
}) async {
  final response = await getGroupsByChannelWithHttpInfo(
    channelId,
    page: page,
    perPage: perPage,
    filterAllowReference: filterAllowReference,
  );
  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<MmGroup>') as List).cast<MmGroup>().toList();
  }
  return null;
}