deleteChannel method

Future<DeleteChannelResponse> deleteChannel({
  1. required String channelId,
})

Starts deletion of channel. The associated outputs are also deleted.

May throw BadRequestException. May throw InternalServerErrorException. May throw ForbiddenException. May throw BadGatewayException. May throw NotFoundException. May throw GatewayTimeoutException. May throw TooManyRequestsException. May throw ConflictException.

Parameter channelId : Unique ID of the channel.

Implementation

Future<DeleteChannelResponse> deleteChannel({
  required String channelId,
}) async {
  ArgumentError.checkNotNull(channelId, 'channelId');
  final response = await _protocol.send(
    payload: null,
    method: 'DELETE',
    requestUri: '/prod/channels/${Uri.encodeComponent(channelId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DeleteChannelResponse.fromJson(response);
}