listDirectMessageConversations method

Future<ListChannelsResponse?> listDirectMessageConversations({
  1. List<String>? accountIds,
  2. List<String>? providers,
  3. String? xWorkspaceID,
  4. int? limit,
  5. String? cursor,
  6. bool? includeArchived,
})

List 1:1 and group DM conversations.

Returns DM-type conversations only (type: im | mpim). Channel-type conversations are surfaced via /v1/channels.

Parameters:

  • List<String> accountIds: Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to providers — when both are set the intersection is used.

  • List<String> providers: Repeatable. Restrict to these provider ids (gmail, outlook).

  • String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • int limit:

  • String cursor:

  • bool includeArchived:

Implementation

Future<ListChannelsResponse?> listDirectMessageConversations({ List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? includeArchived, }) async {
  final response = await listDirectMessageConversationsWithHttpInfo( accountIds: accountIds, providers: providers, xWorkspaceID: xWorkspaceID, limit: limit, cursor: cursor, includeArchived: includeArchived, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(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), 'ListChannelsResponse',) as ListChannelsResponse;

  }
  return null;
}