MessageListParams
An object contains set of options for get message methods
Since
3.0.181-
The number of messages to retrieve that were sent before the specified timestamp or message ID. Default is 20
-
The number of messages to retrieve that were sent after the specified timestamp or message ID. Default is 0
-
Determines whether to include the messages with the matching timestamp or message ID in the results. Default is
false
-
Determines whether to sort the retrieved messages in reverse order. If
false
, the results are in ascending order. Default isfalse
-
Restricts the search scope only to retrieve messages with the specified message type. Default is
.all
-
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
nil
. If thecustomTypes
is set, this property is ignored. -
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
nil
. -
Determines whether to include the metaarray information of the messages in the results. Default is
false
-
Determines whether to include the reactions to the messages in the results. Default is
false
-
Determines whether to include the thread information of the messages in the results when the results contain root messages.
Note
The default value isfalse
. -
Determines whether to include parent message info. Default is
false
-
Determines which reply types to include. Default is
.none
-
Determines whether to include only messages from the subChannel to which you belong in the results. Default is
false
Warning
This value is only used in open channels.Since
3.0.204 -
Restricts the search scope only to retrieve the messages with the multiple specified custom message types. When the custom type filtering is not needed, the value should be set to
nil
.Since
3.0.213 -
Default constructor.
-
init(previousResultSize:
nextResultSize: isInclusive: reverse: messageTypeFilter: customType: senderUserIds: includeMetaArray: includeReactions: includeThreadInfo: includeParentMessageInfo: replyType: showSubChannelMessagesOnly: customTypes: ) Parameter constructor
-
Checks whether given message is belonged to this params
-
Checks whether the given params is belonged to this object
-
Copies this object
-