MessageListParams class Null safety

An object consists a set of parameters to retrieve list of messages.

Annotations

Constructors

MessageListParams()

Properties

customType String?
Restricts the search scope only to retrieve the messages with the specified custom message type.
read / write
customTypes List<String>?
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
includeMetaArray bool
Determines whether to include the metaarray information of the messages in the results. default value is false
@JsonKey(name: 'with_sorted_meta_array'), read / write
includeParentMessageText bool
Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is UserMessage the value is a message. If it is FileMessage, the value is the name of the uploaded file. default value is false
read / write
includeReactions bool
Determines whether to include the reactions to the messages in the results. default value is false
read / write
includeReplies bool
Determines whether to include the reactions to the messages in the results. default value is false
read / write
includeThreadInfo bool
Determines whether to include the thread information of the messages in the results when the results contain root messages. default value is false
read / write
isInclusive bool
Determines whether to include the messages with the matching timestamp or message ID in the results.
@JsonKey(name: 'include'), read / write
messageType MessageTypeFilter
Restricts the search scope only to retrieve the messages with the specified message type.
read / write
nextResultSize int
The number of messages to retrieve that were sent after the specified timestamp or message ID.
@JsonKey(name: 'next_limit'), read / write
previousResultSize int
The number of messages to retrieve that were sent before the specified timestamp or message ID.
@JsonKey(name: 'prev_limit'), read / write
reverse bool
Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
senderIds List<String>?
Restricts the search scope only to retrieve the messages sent by the users with the specified user IDs.
read / write
showSubChannelMessagesOnly bool
Determines whether to retrieve sub channel messages on Dynamic Partitioning. This property is only working for OpenChannel
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited