MessageChangeLogsParams

public final 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

    public var includeMetaArray: Bool = false

  • Determines whether to include the reactions of the updated messages in the results. Default is false

    Declaration

    Swift

    public var includeReactions: Bool = false

  • 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

    public var includeThreadInfo: Bool = false

  • Determines wheter to include information on parent message. Default is false

    Declaration

    Swift

    public var includeParentMessageInfo: Bool = false

  • Determines which reply types to include in the results. Default is .none

    Declaration

    Swift

    public var replyType: ReplyType = .none

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Undocumented

    Declaration

    Swift

    public init(
    includeMetaArray: Bool = false,
    includeReactions: Bool = false,
    includeThreadInfo: Bool = false,
    includeParentMessageInfo: Bool = false,
    replyType: ReplyType = .none
)

  • Default parameter constructor

    Since

    4.22.0

    Declaration

    Swift

    public init(builder: ((MessageChangeLogsParams) -> Void)? = nil)

  • Creates PreviousMessageListQuery from a given PreviousMessageListQuery instance.

    Since

    3.0.185

    Declaration

    Swift

    public static 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

    public static func create(with params: MessageListParams?) -> MessageChangeLogsParams

    Parameters

    params

    previous message list query

    Return Value

    A created instance of MessageChangeLogsParams

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    MessageChangeLogsParams instance