channelMembersMinusGroupMembersWithHttpInfo method

Future<Response> channelMembersMinusGroupMembersWithHttpInfo(
  1. String channelId,
  2. String groupIds, {
  3. int? page,
  4. int? perPage,
})

Channel members minus group members.

Get the set of users who are members of the channel minus the set of users who are members of the given groups. Each user object contains an array of group objects representing the group memberships for that user. Each user object contains the boolean fields scheme_guest, scheme_user, and scheme_admin representing the roles that user has for the given channel. ##### Permissions Must have manage_system permission. Minimum server version: 5.14

Note: This method returns the HTTP Response.

Parameters:

  • String channelId (required): Channel GUID

  • String groupIds (required): A comma-separated list of group ids.

  • int page: The page to select.

  • int perPage: The number of users per page.

Implementation

Future<Response> channelMembersMinusGroupMembersWithHttpInfo(
  String channelId,
  String groupIds, {
  int? page,
  int? perPage,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/channels/{channel_id}/members_minus_group_members'.replaceAll('{channel_id}', channelId);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <MmQueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  queryParams.addAll(_queryParams('', 'group_ids', groupIds));
  if (page != null) {
    queryParams.addAll(_queryParams('', 'page', page));
  }
  if (perPage != null) {
    queryParams.addAll(_queryParams('', 'per_page', perPage));
  }

  const contentTypes = <String>[];

  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}