patchChannel method

Future<MmChannel?> patchChannel(String channelId, MmPatchChannelRequest mmPatchChannelRequest)

Patch a channel

Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions If updating a public channel, manage_public_channel_members permission is required. If updating a private channel, manage_private_channel_members permission is required.

Parameters:

• String channelId (required): Channel GUID

• MmPatchChannelRequest mmPatchChannelRequest (required): Channel object to be updated

Implementation

Future<MmChannel?> patchChannel(
  String channelId,
  MmPatchChannelRequest mmPatchChannelRequest,
) async {
  final response = await patchChannelWithHttpInfo(
    channelId,
    mmPatchChannelRequest,
  );
  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;
}