searchArchivedChannels method

Future<List<MmChannel>?> searchArchivedChannels(String teamId, MmSearchArchivedChannelsRequest mmSearchArchivedChannelsRequest)

Search archived channels

Search archived channels on a team based on the search term provided in the request body. Minimum server version: 5.18 ##### Permissions Must have the list_team_channels permission. In server version 5.18 and later, a user without the list_team_channels permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.

Parameters:

• String teamId (required): Team GUID

• MmSearchArchivedChannelsRequest mmSearchArchivedChannelsRequest (required): Search criteria

Implementation

Future<List<MmChannel>?> searchArchivedChannels(
  String teamId,
  MmSearchArchivedChannelsRequest mmSearchArchivedChannelsRequest,
) async {
  final response = await searchArchivedChannelsWithHttpInfo(
    teamId,
    mmSearchArchivedChannelsRequest,
  );
  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<MmChannel>') as List).cast<MmChannel>().toList();
  }
  return null;
}