MessagesRequest class
A request object for fetching messages.
Properties
-
attachmentTypes
↔ List<
String> ? -
Attachment types to filter by.
getter/setter pair
-
categories
→ List<
String> ? -
Categories for filtering.
final
- category → String?
-
Category of the messages.
final
- guid → String?
-
Group ID for which the messages are to be fetched.
final
- hasAttachments → bool?
-
Flag to only fetch messages that includes attachments
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasLinks → bool?
-
Flag to only fetch messages that includes links
final
- hasMentions → bool?
-
Flag to fetch messages with self mention
final
- hasReactions → bool?
-
Flag to only fetch messages that includes reactions
final
- hideDeleted → bool?
-
Flag to hide deleted messages.
final
- hideMessagesFromBlockedUsers → bool?
-
Flag to hide messages from blocked users.
final
- hideQuotedMessages → bool?
-
Flag to include hide quoted messages
final
- hideReplies → bool?
-
Flag to hide replies.
final
- interactionGoalCompletedOnly → bool?
-
Flag to include messages with completed interaction goals.
final
- key ↔ String?
-
Key for pagination.
getter/setter pair
- limit → int?
-
Number of results to limit the query.
final
-
mentionedUids
→ List<
String> ? -
List of uid that messages contains
final
- messageId → int?
-
Message ID from which the messages are to be fetched.
final
- parentMessageId → int?
-
Parent message ID for thread messages.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchKeyword → String?
-
Keyword for searching.
final
-
Tags for filtering.
final
- timestamp → DateTime?
-
Timestamp from which the messages are to be fetched.
final
- type → String?
-
Type of the messages.
final
-
types
→ List<
String> ? -
Types for filtering.
final
- uid → String?
-
User ID for which the messages are to be fetched.
final
- unread → bool?
-
Flag to include only unread messages.
final
- updatedAfter → DateTime?
-
Time from which the messages are to be updated.
final
- updatesOnly → bool?
-
Flag to include only updates.
final
- withParent → bool?
-
Flag to include parent message with the replies
final
- withTags → bool?
-
Flag to include tags.
final
Methods
-
fetchNext(
{required dynamic onSuccess(List< BaseMessage> message)?, required dynamic onError(CometChatException excep)?}) → Future<List< BaseMessage> > - Returns a list of BaseMessage object fetched after putting the filters.
-
fetchPrevious(
{required dynamic onSuccess(List< BaseMessage> message)?, required dynamic onError(CometChatException excep)?}) → Future<List< BaseMessage> > - Returns a list of BaseMessage object fetched after putting the filters.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- defaultLimit → int?
-
Default limit for the number of results.
final
- maxLimit → int?
-
Maximum limit for the number of results.
final