Inheritance diagram for SendBird.BaseMessageListParams:

Public Member Functions
	BaseMessageListParams (int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List< String > senderUserIds, bool isInclusive, bool reverse, bool includeMetaArray, bool includeReactions, bool includeParentMessageText)

void	SetPreviousResultSize (int previousResultSize)

void	SetNextResultSize (int nextResultSize)

void	SetMessageType (BaseChannel.MessageTypeFilter messageType)

void	SetCustomType (String customType)

void	SetSenderUserIds (List< String > senderUserIds)

void	SetInclusive (bool inclusive)

void	SetReverse (bool reverse)

void	SetIncludeMetaArray (bool includeMetaArray)

void	SetIncludeReactions (bool includeReactions)

void	SetIncludeParentMessageText (bool includeParentMessageText)

override string	ToString ()

Properties
int	GetPreviousResultSize `[get]`

int	GetNextResultSize `[get]`

BaseChannel.MessageTypeFilter	GetMessageType `[get]`

String	GetCustomType `[get]`

List< string >	GetSenderUserIds `[get]`

bool	IsInclusive `[get]`

bool	ShouldReverse `[get]`

bool	ShouldIncludeMetaArray `[get]`

bool	ShouldIncludeReactions `[get]`

bool	ShouldIncludeParentMessageText `[get]`

Member Function Documentation

◆ SetCustomType()

void SendBird.BaseMessageListParams.SetCustomType ( String customType )

inline

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.

Parameters

customType custom type for messages.

Since: 3.0.18

◆ SetIncludeMetaArray()

void SendBird.BaseMessageListParams.SetIncludeMetaArray ( bool includeMetaArray )

inline

Determines whether to include the meta array information of the updated messages in the results.

Parameters

includeMetaArray If true the result will be returned with message meta array.

Since: 3.0.18

◆ SetIncludeParentMessageText()

void SendBird.BaseMessageListParams.SetIncludeParentMessageText ( bool includeParentMessageText )

inline

Determines whether to include the parent message text in the results when the updated messages are replies in a thread. If the type of the parent message is UserMessage, the value is a BaseMessage#getMessage() of the parent message. If it is FileMessage, the value is the name of the uploaded file.

Parameters

includeParentMessageText If true the result will be returned with messages with parent's message's text, if the message is a reply message.

Since: 3.0.18

◆ SetIncludeReactions()

void SendBird.BaseMessageListParams.SetIncludeReactions ( bool includeReactions )

inline

Determines whether to include the reactions to the updated messages in the results.

Parameters

includeReactions If true the result will be returned with message reactions.

Since: 3.0.18

◆ SetInclusive()

void SendBird.BaseMessageListParams.SetInclusive ( bool inclusive )

inline

Determines whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.

Parameters

inclusive If true, the result will include messages with createdAt same as the given timestamp.

Since: 3.0.18

◆ SetMessageType()

void SendBird.BaseMessageListParams.SetMessageType ( BaseChannel.MessageTypeFilter messageType )

inline

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

Parameters

messageType type of messages that should be loaded.

Since: 3.0.18

◆ SetNextResultSize()

void SendBird.BaseMessageListParams.SetNextResultSize ( int nextResultSize )

inline

Set the number of newer messages added either before the timestamp or the message that has a specific message ID.

Parameters

nextResultSize number of loaded message size.

Since: 3.0.18

◆ SetPreviousResultSize()

void SendBird.BaseMessageListParams.SetPreviousResultSize ( int previousResultSize )

inline

Set the number of previous messages added either before the timestamp or the message that has a specific message ID.

Parameters

previousResultSize number of loaded message size.

Since: 3.0.18

◆ SetReverse()

void SendBird.BaseMessageListParams.SetReverse ( bool reverse )

inline

Determines whether to sort the retrieved messages in reverse order.

Parameters

reverse If true the result will be returned by creation time descending order.

Since: 3.0.18

◆ SetSenderUserIds()

void SendBird.BaseMessageListParams.SetSenderUserIds ( List< String > senderUserIds )

inline

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.

Parameters

senderUserIds list of sender's user ids.

Since: 3.0.18

Property Documentation

◆ GetCustomType

String SendBird.BaseMessageListParams.GetCustomType

get

Returns the custom type of message.

Returns: The custom type of message.

Since: 3.0.18

◆ GetMessageType

BaseChannel.MessageTypeFilter SendBird.BaseMessageListParams.GetMessageType

get

Returns the message type.

Returns: The message type.

Since: 3.0.18

◆ GetNextResultSize

int SendBird.BaseMessageListParams.GetNextResultSize

get

Returns the number of newer messages that you want to get.

Returns: number of loaded message size.

Since: 3.0.18

◆ GetPreviousResultSize

int SendBird.BaseMessageListParams.GetPreviousResultSize

get

Returns the number of previous messages that you want to get.

Returns: number of loaded message size.

Since: 3.0.18

◆ GetSenderUserIds

List<string> SendBird.BaseMessageListParams.GetSenderUserIds

get

Returns the sender user ids.

Returns: The sender user ids.

Since: 3.0.18

◆ IsInclusive

bool SendBird.BaseMessageListParams.IsInclusive

get

Returns a value whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.

Returns: Whether messages sent exactly on the timestamp should be loaded.

Since: 3.0.18

◆ ShouldIncludeMetaArray

bool SendBird.BaseMessageListParams.ShouldIncludeMetaArray

get

Returns whether the meta arrays should be included in the results.

Returns: Whether the meta arrays should be included in the results.

Since: 3.0.18

◆ ShouldIncludeParentMessageText

bool SendBird.BaseMessageListParams.ShouldIncludeParentMessageText

get

Returns whether the text of a parent message should be included in the reply messages included in the results.

Returns: Whether the text of a parent message should be included in the reply messages included in the results.

Since: 3.0.18

◆ ShouldIncludeReactions

bool SendBird.BaseMessageListParams.ShouldIncludeReactions

get

Returns whether the reaction data should be included in the results.

Returns: Whether the reaction data should be included in the results.

Since: 3.0.18

◆ ShouldReverse

bool SendBird.BaseMessageListParams.ShouldReverse

get

Returns whether the results should be reversed.

Returns: whether the results should be reversed.

Since: 3.0.18

The documentation for this class was generated from the following file:

SendBird/src/BaseMessageListParams.cs

Public Member Functions

Properties

Member Function Documentation

◆ SetCustomType()

◆ SetIncludeMetaArray()

◆ SetIncludeParentMessageText()

◆ SetIncludeReactions()

◆ SetInclusive()

◆ SetMessageType()

◆ SetNextResultSize()

◆ SetPreviousResultSize()

◆ SetReverse()

◆ SetSenderUserIds()

Property Documentation

◆ GetCustomType

◆ GetMessageType

◆ GetNextResultSize

◆ GetPreviousResultSize

◆ GetSenderUserIds

◆ IsInclusive

◆ ShouldIncludeMetaArray

◆ ShouldIncludeParentMessageText

◆ ShouldIncludeReactions

◆ ShouldReverse