ThreadedMessageListParams class Null safety
An object consists a set of parameters to retrieve list of a threaded message
- Inheritance
-
- Object
- BaseMessageFetchParams
- ThreadedMessageListParams
- Annotations
Constructors
Properties
- customType ↔ String?
-
Restricts the search scope only to retrieve the messages with the
specified custom message type. When the custom type filtering is
not needed, the value should be set to
null
.read / write - hashCode → int
-
The hash code for this object.
read-onlyinherited
- includeMetaArray ↔ bool
-
Determines whether to include the metaarray information of the
messages in the results. default value is false
read / writeinherited
- includeParentMessageInfo ↔ bool
-
Determines wheter to include parent message info in the results
read / writeinherited
- 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 amessage
. If it isFileMessage
, the value is thename
of the uploaded file. default value is falseread / writeinherited - includeReactions ↔ bool
-
Determines whether to include the reactions to the messages
in the results. default value is false
read / writeinherited
- includeReplies ↔ bool?
-
Determines whether to include the reactions to the messages in the results.
default value is false
read / writeinherited
- 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 / writeinherited
- isInclusive ↔ bool
-
Determines whether to include the messages with the matching
timestamp or message ID in the results.
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.
read / write
- previousResultSize ↔ int
-
The number of messages to retrieve that were sent before the
specified timestamp or message ID.
read / write
- replyType ↔ ReplyType?
-
Determines message's reply type
read / writeinherited
- 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-onlyinherited
-
senderIds
↔ List<
String> ? -
Restricts the search scope only to retrieve the messages sent by
the users with the specified user IDs. When the user ID filtering
is not needed, the value should be set to
null
.read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited