MessageChangeLogsParams

@objc(SBDMessageChangeLogsParams)
public class MessageChangeLogsParams : NSObject, NSCopying

An object contains set of options for message change logs.

Since

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

    Declaration

    Swift

    @objc
    public var includeMetaArray: Bool
  • Determines whether to include the reactions of the updated messages in the results. Default is false

    Declaration

    Swift

    @objc
    public var includeReactions: Bool
  • Determines whether to include the thread information of the updated messages in the results when the results contain parent messages.

    Note

    The default value is false.

    Declaration

    Swift

    @objc
    public var includeThreadInfo: Bool
  • Determines wheter to include information on parent message. Default is false

    Declaration

    Swift

    @objc
    public var includeParentMessageInfo: Bool
  • Determines which reply types to include in the results. Default is .none

    Declaration

    Swift

    @objc
    public var replyType: ReplyType
  • Default constructor.

    Declaration

    Swift

    public override init()
  • Default parameter constructor

    Declaration

    Swift

    @objc
    public init(
        includeMetaArray: Bool = false,
        includeReactions: Bool = false,
        includeThreadInfo: Bool = false,
        includeParentMessageInfo: Bool = false,
        replyType: ReplyType = .none
    )
  • Creates PreviousMessageListQuery from a given PreviousMessageListQuery instance.

    Since

    3.0.185

    Declaration

    Swift

    @objc(createWithPreviousMessageListQuery:)
    public class func create(with query: PreviousMessageListQuery?) -> MessageChangeLogsParams

    Parameters

    query

    previous message list query

    Return Value

    A created instance of MessageChangeLogsParams

  • Creates MessageChangeLogParams from a given MessageListParams instance.

    Since

    3.0.185

    Declaration

    Swift

    @objc(createWithMessageListParams:)
    public class func create(with params: MessageListParams?) -> MessageChangeLogsParams

    Parameters

    params

    previous message list query

    Return Value

    A created instance of MessageChangeLogsParams

  • Copies this object

    Declaration

    Swift

    @objc
    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    optional NSZone

    Return Value

    MessageChangeLogsParams instance