SBDThreadedMessageListParams Class Reference

Inherits from NSObject
Declared in SBDThreadedMessageListParams.h

Overview

An object that represents the parameters for the getThreadedMessagesByTimestamp:params:completionHandler: method. The method returns 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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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.

@property (strong, nullable) NSString *customType

Availability

3.0.181

Discussion

Note: The default value is nil.

Declared In

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.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

SBDThreadedMessageListParams.h