MessageListParams class
Represents a message list params.
- Inheritance
-
- Object
- BaseMessageFetchParams
- MessageListParams
- Annotations
-
- @JsonSerializable()
Constructors
Properties
-
customTypes
↔ List<
String> ? -
Restricts the search scope only to retrieve the messages that match any of given custom
types.
When the custom type filtering is not needed, the value should be set to null.
When a empty string is given, messages that does not have a custom type will also be
returned.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- includeMetaArray ↔ bool
-
Whether the meta arrays should be included in the results.
getter/setter pairinherited
- includeParentMessageInfo ↔ bool
-
Whether the information of a parent message should be included in the reply messages included in the results.
getter/setter pairinherited
- includeReactions ↔ bool
-
Whether the reaction data should be included in the results.
getter/setter pairinherited
- includeThreadInfo ↔ bool
-
Whether the thread information should be included in the results.
getter/setter pairinherited
- inclusive ↔ bool
-
Determines whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.
getter/setter pair
- messageType ↔ MessageTypeFilter
-
Restricts the search scope only to retrieve the messages with the specified message type.
getter/setter pair
- nextResultSize ↔ int
-
The number of newer messages added either before the timestamp or the message that has a specific message ID.
getter/setter pair
- previousResultSize ↔ int
-
The number of previous messages added either before the timestamp or the message that has a specific message ID.
getter/setter pair
- replyType ↔ ReplyType?
-
Determines the reply types to include in the results.
getter/setter pairinherited
- reverse ↔ bool
-
Determines whether to sort the retrieved messages in reverse order.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
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.
getter/setter pair
- showSubChannelMessagesOnly ↔ bool
-
Whether to show subChannel message only. Defaults to false.
This only takes effect when the requested channel is a dynamically partitioned OpenChannel.
getter/setter pair
Methods
-
copyWith(
BaseMessageFetchParams other) → void -
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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
Static Methods
-
fromJson(
Map< String, dynamic> json) → MessageListParams -
override