SBDMessageChangeLogsParams Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in SBDMessageChangeLogsParams.h

Overview

An object that represents the parameters for the getMessageChangeLogsSinceTimestamp:params:completionHandler: and the getMessageChangeLogsSinceToken:params:completionHandler: methods. The methods return updated messages and the IDs of deleted messages along with additional data according to the properties in this object.

Note: This class is available from 3.0.181

Other Methods

  includeMetaArray

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

@property (atomic) BOOL includeMetaArray

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageChangeLogsParams.h

  includeReactions

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

@property (atomic) BOOL includeReactions

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageChangeLogsParams.h

  includeReplies

Determines whether to include the replies of the updated messages in the results.

@property (atomic) BOOL includeReplies

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageChangeLogsParams.h

  includeParentMessageText

Determines whether to include the parent message text in the results when the updated messages are threaded replies. 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

SBDMessageChangeLogsParams.h

  includeThreadInfo

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

@property (atomic) BOOL includeThreadInfo

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageChangeLogsParams.h

+ createWithPreviousMessageListQuery:

+ (nonnull SBDMessageChangeLogsParams *)createWithPreviousMessageListQuery:(nullable SBDPreviousMessageListQuery *)query

Parameters

query

previous message list query

Return Value

A created instance of SBDMessageChangeLogsParams

Availability

3.0.185

Declared In

SBDMessageChangeLogsParams.h

+ createWithMessageListParams:

Create SBDMessageListParams from a given SBDMessageListParams instance.

+ (nonnull SBDMessageChangeLogsParams *)createWithMessageListParams:(nullable SBDMessageListParams *)params

Parameters

params

previous message list query

Return Value

A created instance of SBDMessageChangeLogsParams

Availability

3.0.185

Declared In

SBDMessageChangeLogsParams.h

Internal Methods

+ createMessageChangeLogsWithoutFilters

+ (nonnull SBDMessageChangeLogsParams *)createMessageChangeLogsWithoutFilters