ScheduledMessageListQueryParams

public final class ScheduledMessageListQueryParams: NSObject
extension ScheduledMessageListQueryParams: NSCopying

Undocumented

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

    Since

    4.0.0

    Declaration

    Swift

    public var limit: Int = 20

  • The order method for the search. Default is .createdAt

    Since

    4.0.0

    Declaration

    Swift

    public var order: ScheduledMessageListOrder = .createdAt

  • A Boolean value that indicates whether to reverse the queried result list. Default is false.

    Since

    4.0.0

    Declaration

    Swift

    public var reverse: Bool = false

  • 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

    public var scheduledStatusOptions: ScheduledStatusOptions = []

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

    Since

    4.0.0

    Declaration

    Swift

    public var messageTypeFilter: MessageTypeFilter = .all

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Initializes and returns a newly allocated params object that mutated through builder closure.

    Declaration

    Swift

    public init(builder: (ScheduledMessageListQueryParams) -> Void)

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

Equatable

  • Undocumented

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool

NSCopying

  • Undocumented

    Declaration

    Swift

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