getChannelByNameForTeamName method

Future<MmChannel?> getChannelByNameForTeamName(
  1. String teamName,
  2. String channelName, {
  3. bool? includeDeleted,
})

Get a channel by name and team name

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

Parameters:

  • String teamName (required): Team Name

  • String channelName (required): Channel Name

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

Implementation

Future<MmChannel?> getChannelByNameForTeamName(
  String teamName,
  String channelName, {
  bool? includeDeleted,
}) async {
  final response = await getChannelByNameForTeamNameWithHttpInfo(
    teamName,
    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;
}