getConversations method

Future<List<SmsConversation>> getConversations({
  1. ConversationFilter? filter,
  2. List<OrderBy>? sortOrder,
})

Query SMS Inbox.

Requires READ_SMS permission.

Parameters:

  • filter (optional) : ConversationFilter to filter the results of this query. Works like SQL WHERE clause.
  • sortOrder (optional): List of OrderBy. Orders the results of this query by the provided columns and order.

Returns:

Future<List<SmsConversation>>

Implementation

Future<List<SmsConversation>> getConversations(
    {ConversationFilter? filter, List<OrderBy>? sortOrder}) async {
  assert(_platform.isAndroid == true, "Can only be called on Android.");
  final args = _getArguments(DEFAULT_CONVERSATION_COLUMNS, filter, sortOrder);

  final conversations = await _foregroundChannel.invokeMethod<List?>(
      GET_ALL_CONVERSATIONS, args);

  return conversations
          ?.map((conversation) => SmsConversation.fromMap(conversation))
          .toList(growable: false) ??
      List.empty();
}