FetchMessageOptions constructor

const FetchMessageOptions(
  1. {String? from,
  2. List<MessageType>? msgTypes,
  3. int startTs = -1,
  4. int endTs = -1,
  5. bool needSave = false,
  6. ChatSearchDirection direction = ChatSearchDirection.Up}
)

The parameter configuration class for pulling historical messages from the server.

Param direction The message search direction, Default is ChatSearchDirection.Up. See ChatSearchDirection.

Param from The user ID of the message sender in the group conversation.

Param msgTypes The array of message types for query. The default value is null, indicating that all types of messages are retrieved.

Param startTs The start time for message query. The time is a UNIX time stamp in milliseconds. The default value is -1, indicating that this parameter is ignored during message query. If the startTs is set to a specific time spot and the endTs uses the default value -1, the SDK returns messages that are sent and received in the period that is from the start time to the current time. If the startTs uses the default value -1 and the endTs is set to a specific time spot, the SDK returns messages that are sent and received in the period that is from the timestamp of the first message to the current time.

Param endTs The end time for message query. The time is a UNIX time stamp in milliseconds. The default value is -1, indicating that this parameter is ignored during message query. If the startTs is set to a specific time spot and the endTs uses the default value -1, the SDK returns messages that are sent and received in the period that is from the start time to the current time. If the startTs uses the default value -1 and the endTs is set to a specific time spot, the SDK returns messages that are sent and received in the period that is from the timestamp of the first message to the current time.

Param needSave Whether to save the retrieved messages to the database:

  • true: save to database;
  • false(Default)：no save to database.

Implementation

const FetchMessageOptions({
  this.from,
  this.msgTypes,
  this.startTs = -1,
  this.endTs = -1,
  this.needSave = false,
  this.direction = ChatSearchDirection.Up,
});