searchChannelsForRetentionPolicy method

Future<List<MmChannelWithTeamData>?> searchChannelsForRetentionPolicy(String policyId, MmSearchChannelsForRetentionPolicyRequest mmSearchChannelsForRetentionPolicyRequest)

Search for the channels in a granular data retention policy

Searches for the channels to which a granular data retention policy is applied. Minimum server version: 5.35 ##### Permissions Must have the sysconsole_read_compliance_data_retention permission. ##### License Requires an E20 license.

Parameters:

• String policyId (required): The ID of the granular retention policy.

• MmSearchChannelsForRetentionPolicyRequest mmSearchChannelsForRetentionPolicyRequest (required):

Implementation

Future<List<MmChannelWithTeamData>?> searchChannelsForRetentionPolicy(
  String policyId,
  MmSearchChannelsForRetentionPolicyRequest mmSearchChannelsForRetentionPolicyRequest,
) async {
  final response = await searchChannelsForRetentionPolicyWithHttpInfo(
    policyId,
    mmSearchChannelsForRetentionPolicyRequest,
  );
  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) {
    final responseBody = await _decodeBodyBytes(response);
    return (await apiClient.deserializeAsync(responseBody, 'List<MmChannelWithTeamData>') as List)
        .cast<MmChannelWithTeamData>()
        .toList();
  }
  return null;
}