PreviousMessageListQuery

@objc(SBDPreviousMessageListQuery)
public final class PreviousMessageListQuery : NSObject, Queryable

An object which retrieves messages from the given channel.

The instance of this class is created by createPreviousMessageListQuery() in BaseChannel class.

  • indicates there are more data to fetch

    Declaration

    Swift

    @objc
public internal(set) var hasNext: Bool { get }

  • Indicates the query is currently loading or not

    Declaration

    Swift

    @objc
public internal(set) var isLoading: Bool { get }

  • Fetches next page

    Declaration

    Swift

    @objc
public func loadNextPage(completionHandler: @escaping MessageListHandler)

    Parameters

    completionHandler

    completion handler

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    PreviousMessageListQuery instance

Params Bridge

  • Sets the order of messages. If true, the latest message is the index 0. The default value is false.

    Since

    3.0.106

    Declaration

    Swift

    @objc
public var reverse: Bool { get }

  • Sets the message type to filter messages. The default value is .all.

    Since

    3.0.106

    Declaration

    Swift

    @objc
public var messageTypeFilter: MessageTypeFilter { get }

  • Sets the custom type to filter messages.

    Since

    3.0.106

    Declaration

    Swift

    @objc
public var customTypeFilter: String? { get }

  • Sets the custom types to filter messages.

    Since

    3.0.213

    Declaration

    Swift

    @objc
public var customTypesFilter: [String]? { get }

  • Sets the senders’ user IDs filter.

    Since

    3.0.106

    Declaration

    Swift

    @objc
public var senderUserIdsFilter: [String]? { get }

  • Determines message object include meta array. Default is false

    Since

    3.0.116

    Declaration

    Swift

    @objc
public var includeMetaArray: Bool { get }

  • Determines message object include reactions. Default is false

    Since

    3.0.168

    Declaration

    Swift

    @objc
public var includeReactions: Bool { get }

  • Determines whether to include the thread information of the messages in the results when the results contain parent messages. Default is false

    Since

    3.0.181

    Declaration

    Swift

    @objc
public var includeThreadInfo: Bool { get }

  • Determines whether to include parent message information of the messages in the results when the results contain reply messages. Default is false

    Declaration

    Swift

    @objc
public var includeParentMessageInfo: Bool { get }

  • Sets the reply type to filter messages. The default value is .none.

    Declaration

    Swift

    @objc
public var replyType: ReplyType { get }

  • Determines whether to include only messages from the subChannel to which you belong in the results. Default is false

    Note

    This value is only used in open channels.

    Since

    3.0.204

    Declaration

    Swift

    @objc
public var showSubChannelMessagesOnly: Bool { get }

  • fetch limit

    Declaration

    Swift

    @objc
public var limit: UInt { get }