getSentSms method

Future<List<SmsMessage>> getSentSms({
  1. List<SmsColumn> columns = DEFAULT_SMS_COLUMNS,
  2. SmsFilter? filter,
  3. List<OrderBy>? sortOrder,
})

Query SMS Outbox / Sent messages.

Requires READ_SMS permission.

Parameters:

  • columns (optional) : List of SmsColumn to be returned by this query. Defaults to SmsColumn.ID, SmsColumn.ADDRESS, SmsColumn.BODY, SmsColumn.DATE
  • filter (optional) : SmsFilter 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<SmsMessage>>

Implementation

Future<List<SmsMessage>> getSentSms(
    {List<SmsColumn> columns = DEFAULT_SMS_COLUMNS,
    SmsFilter? filter,
    List<OrderBy>? sortOrder}) async {
  assert(_platform.isAndroid == true, "Can only be called on Android.");
  final args = _getArguments(columns, filter, sortOrder);

  final messages =
      await _foregroundChannel.invokeMethod<List?>(GET_ALL_SENT_SMS, args);

  return messages
          ?.map((message) => SmsMessage.fromMap(message, columns))
          .toList(growable: false) ??
      List.empty();
}