ThreadedMessageListParams

public final class ThreadedMessageListParams: NSObject, NSCopying

An object contains set of options to retrieve threaded messages.

Since

3.0.181

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

    Declaration

    Swift

    public var previousResultSize: Int = 0

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

    Declaration

    Swift

    public var nextResultSize: Int = 0

  • Determines whether to include the messages with the matching timestamp or message ID in the results. Default is false.

    Declaration

    Swift

    public var isInclusive: Bool = false

  • Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. Default is false.

    Declaration

    Swift

    public var reverse: Bool = false

  • Restricts the search scope only to retrieve messages with the specified message type. Default is .all.

    Declaration

    Swift

    public var messageTypeFilter: MessageTypeFilter = .all

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

    Declaration

    Swift

    public var customType: String?

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

    Declaration

    Swift

    public var senderUserIds: [String]?

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

    Declaration

    Swift

    public var includeMetaArray: Bool = false

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

    Declaration

    Swift

    public var includeReactions: Bool = false

  • Determines whether to include the parent message information to the message in the results. Default is false.

    Since

    3.0.236

    Declaration

    Swift

    public var includeParentMessageInfo: Bool = false

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

    Note

    The default value is nil.

    Since

    3.0.213

    Declaration

    Swift

    public var customTypes: [String]?

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Parameter constructor.

    Declaration

    Swift

    @available(*, deprecated, renamed: "init(builder:﹚")
public init(
    previousResultSize: Int = 0,
    nextResultSize: Int = 0,
    isInclusive: Bool = false,
    reverse: Bool = false,
    messageTypeFilter: MessageTypeFilter = .all,
    customType: String? = nil,
    senderUserIds: [String]? = nil,
    includeMetaArray: Bool = false,
    includeReactions: Bool = false,
    includeParentMessageInfo: Bool = false,
    customTypes: [String]? = nil
)

  • Parameter constructor.

    Declaration

    Swift

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

  • Copies this object.

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    ThreadedMessageListParams instance