FetchMessageOptions class
~english The parameter configuration class for pulling historical messages from the server. ~end
~chinese 从服务端查询历史消息的参数配置类。 ~end
Constructors
-
FetchMessageOptions({String? from, List<
MessageType> ? msgTypes, int startTs = -1, int endTs = -1, bool needSave = false, ChatSearchDirection direction = ChatSearchDirection.Up}) -
~english
The parameter configuration class for pulling historical messages from the server.
const
Properties
- direction → ChatSearchDirection
-
~english
The message search direction, Default is ChatSearchDirection.Up. See ChatSearchDirection.
~end
final
- endTs → int
-
~english
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. ~endfinal - from → String?
-
~english
The user ID of the message sender in the group conversation.
~end
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
msgTypes
→ List<
MessageType> ? -
~english
The array of message types for query. The default value is
null
, indicating that all types of messages are retrieved. ~endfinal - needSave → bool
-
~english
Whether to save the retrieved messages to the database:
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startTs → int
-
~english
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.
~end
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited