getChannelByName method

Future<MmChannel?> getChannelByName(String teamId, String channelName, { bool? includeDeleted, })

Get a channel by name

Gets channel from the provided team id and channel name strings. ##### Permissions read_channel permission for the channel.

Parameters:

• String teamId (required): Team GUID

• String channelName (required): Channel Name

• bool includeDeleted: Defines if deleted channels should be returned or not (Mattermost Server 5.26.0+)

Implementation

Future<MmChannel?> getChannelByName(
  String teamId,
  String channelName, {
  bool? includeDeleted,
}) async {
  final response = await getChannelByNameWithHttpInfo(
    teamId,
    channelName,
    includeDeleted: includeDeleted,
  );
  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) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'MmChannel',
    ) as MmChannel;
  }
  return null;
}