SbThreadedMessageListParams

Represents a message list params. More...

Properties
int	PreviousResultSize = 0 [get, set]
	The number of messages to retrieve that were sent before the specified timestamp or message ID. Default is 0 More...
int	NextResultSize = 0 [get, set]
	The number of messages to retrieve that were sent after the specified timestamp or message ID. Default is 0 More...
bool	IsInclusive = false [get, set]
	Determines whether to include the messages with the matching timestamp or message ID in the results. Default is false More...
bool	Reverse = false [get, set]
	Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. Default is false More...
SbMessageTypeFilter	MessageTypeFilter = SbMessageTypeFilter.All [get, set]
	Restricts the search scope only to retrieve messages with the specified message type. Default is All More...
List< string >	CustomTypes [get, set]
	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 `null. More...
List< string >	SenderUserIds [get, set]
	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. More...
bool	IncludeMetaArray = false [get, set]
	Determines whether to include the metaarray information of the messages in the results. Default is false More...
bool	IncludeReactions = false [get, set]
	Determines whether to include the reactions to the messages in the results. Default is false More...
bool	IncludeParentMessageInfo = false [get, set]
	Determines whether to include parent message info. Default is false More...

Detailed Description

Represents a message list params.

Since

4.0.0

Property Documentation

CustomTypes

List<string> CustomTypes

getset

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 `null.

Since

4.0.0

IncludeMetaArray

bool IncludeMetaArray = false

getset

Determines whether to include the metaarray information of the messages in the results. Default is false

Since

4.0.0

IncludeParentMessageInfo

bool IncludeParentMessageInfo = false

getset

Determines whether to include parent message info. Default is false

Since

4.0.0

IncludeReactions

bool IncludeReactions = false

getset

Determines whether to include the reactions to the messages in the results. Default is false

Since

4.0.0

IsInclusive

bool IsInclusive = false

getset

Determines whether to include the messages with the matching timestamp or message ID in the results. Default is false

Since

4.0.0

MessageTypeFilter

SbMessageTypeFilter MessageTypeFilter = SbMessageTypeFilter.All

getset

Restricts the search scope only to retrieve messages with the specified message type. Default is All

Since

4.0.0

NextResultSize

int NextResultSize = 0

getset

The number of messages to retrieve that were sent after the specified timestamp or message ID. Default is 0

Since

4.0.0

PreviousResultSize

int PreviousResultSize = 0

getset

The number of messages to retrieve that were sent before the specified timestamp or message ID. Default is 0

Warning

This value is only used in open channels.

Since

4.0.0

Reverse

bool Reverse = false

getset

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. Default is false

Since

4.0.0

SenderUserIds

List<string> SenderUserIds

getset

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.

Since

4.0.0