listChannelBans method

Future<ListChannelBansResponse> listChannelBans({
  1. required String channelArn,
  2. int? maxResults,
  3. String? nextToken,
})

Lists all the users banned from a particular channel.

May throw BadRequestException. May throw ForbiddenException. May throw UnauthorizedClientException. May throw ThrottledClientException. May throw ServiceUnavailableException. May throw ServiceFailureException.

Parameter channelArn : The ARN of the channel.

Parameter maxResults : The maximum number of bans that you want returned.

Parameter nextToken : The token passed by previous API calls until all requested bans are returned.

Implementation

Future<ListChannelBansResponse> listChannelBans({
  required String channelArn,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(channelArn, 'channelArn');
  _s.validateStringLength(
    'channelArn',
    channelArn,
    5,
    1600,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    2048,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'max-results': [maxResults.toString()],
    if (nextToken != null) 'next-token': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/channels/${Uri.encodeComponent(channelArn)}/bans',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListChannelBansResponse.fromJson(response);
}