ScheduledMessageListQuery

@objc(SBDScheduledMessageListQuery)
public class ScheduledMessageListQuery : NSObject
extension ScheduledMessageListQuery: NSCopying

The ScheduledMessageListQuery class is a query class for getting the list of scheduled messages.

Since

4.0.0
  • A Boolean value that indicates whether there are more data to fetch.

    Declaration

    Swift

    @objc
    public private(set) var hasNext: Bool { get }
  • A Boolean value that indicates the query is currently loading or not.

    Declaration

    Swift

    @objc
    public private(set) var isLoading: Bool { get }
  • Fetches next page.

    Declaration

    Swift

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

    Parameters

    completionHandler

    The completion handler.

NSCopying

  • Undocumented

    Declaration

    Swift

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

Params Bridge

  • The maximum number of BaseMessages per queried page. Default is 20.

    Since

    4.0.0

    Declaration

    Swift

    @objc
    public var limit: Int { get }
  • The order method for the search. Default is .createdAt

    Since

    4.0.0

    Declaration

    Swift

    @objc
    public var order: ScheduledMessageListOrder { get }
  • A Boolean value that indicates whether to reverse the queried result list. Default is false.

    Since

    4.0.0

    Declaration

    Swift

    @objc
    public var reverse: Bool { get }
  • Restricts the search scope only to retrieve the messages with the specified message status. If not specified, all messages are retrieved.

    Since

    4.0.0

    Declaration

    Swift

    @objc
    public var scheduledStatusOptions: ScheduledStatusOptions { get }
  • Restricts the search scope only to retrieve messages with the specified message type. Default is .all.

    Since

    4.0.0

    Declaration

    Swift

    @objc
    public var messageTypeFilter: MessageTypeFilter { get }