SBDMessageListParams Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in SBDMessageListParams.h

Overview

An object that represents the parameters for the getMessagesByTimestamp:params:completionHandler: and the getMessagesByMessageId:params:completionHandler: methods. The methods return messages according to the properties in this object.

Note: This class is available from 3.0.181

  previousResultSize

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

@property (atomic) NSInteger previousResultSize

Availability

3.0.181

Discussion

Note: The default value is 0.

Declared In

SBDMessageListParams.h

  nextResultSize

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

@property (atomic) NSInteger nextResultSize

Availability

3.0.181

Discussion

Note: The default value is 0.

Declared In

SBDMessageListParams.h

  isInclusive

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

@property (atomic) BOOL isInclusive

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  reverse

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

@property (atomic) BOOL reverse

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  messageType

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

@property (atomic) SBDMessageTypeFilter messageType

Availability

3.0.181

Discussion

Note: The default value is SBDMessageTypeFilterAll.

Declared In

SBDMessageListParams.h

  customType

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 the customTypes is set, this property is ignored.

@property (strong, nullable) NSString *customType

Availability

3.0.181

Discussion

Note: The default value is nil.

Declared In

SBDMessageListParams.h

  senderUserIds

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.

@property (strong, nullable) NSArray<NSString*> *senderUserIds

Availability

3.0.181

Discussion

Note: The default value is nil.

Declared In

SBDMessageListParams.h

  includeMetaArray

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

@property (atomic) BOOL includeMetaArray

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  includeReactions

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

@property (atomic) BOOL includeReactions

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  includeReplies

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

@property (atomic) BOOL includeReplies

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  includeParentMessageText

Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is SBDUserMessage, the value is a message. If it is SBDFileMessage, the value is the name of the uploaded file.

@property (atomic) BOOL includeParentMessageText

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  includeThreadInfo

Determines whether to include the thread information of the messages in the results when the results contain root messages.

@property (atomic) BOOL includeThreadInfo

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageListParams.h

  showSubChannelMessagesOnly

Determines whether to include only messages from the subChannel to which you belong in the results.

@property (atomic) BOOL showSubChannelMessagesOnly

Availability

3.0.204

Discussion

Note: The default value is NO.

Warning: This value is only used in open channels.

Declared In

SBDMessageListParams.h

  customTypes

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.

@property (strong, nonatomic, nullable) NSArray<NSString*> *customTypes

Availability

3.0.213

Discussion

Note: The default value is nil.

Declared In

SBDMessageListParams.h

– belongsTo:

- (BOOL)belongsTo:(nonnull SBDBaseMessage *)message