MessageSearchQueryParams

@objc(SBDMessageSearchQueryParams)
public class MessageSearchQueryParams : NSObject, Codable
extension MessageSearchQueryParams: NSCopying

Message search query builder

  • Keyword to search for.

    Declaration

    Swift

    @objc
public var keyword: String?

  • Channel url of the channel you want to set as a scope for the search.

    Declaration

    Swift

    @objc
public var channelURL: String?

  • Channel custom type you want to set as a scope for the search.

    Declaration

    Swift

    @objc
public var channelCustomType: String?

  • Should reverse the queried result list. Default is false

    Declaration

    Swift

    @objc
public var reverse: Bool

  • Should search as a complete, exact phrase. Default is false

    Declaration

    Swift

    @objc
public var exactMatch: Bool

  • Starting timestamp to search from. Default is 0

    Declaration

    Swift

    @objc
public var messageTimestampFrom: Int64

  • Ending timestamp to search to. Default is 0

    Declaration

    Swift

    @objc
public var messageTimestampTo: Int64

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

    Declaration

    Swift

    @objc
public var order: MessageSearchQueryOrder

  • The maximum number of SBDBaseMessages per queried page. Default is 20, maximum is 999 (<1000)

    Declaration

    Swift

    @objc
public var limit: UInt

  • Whether treat keyword field as advanced query or not

    Since

    3.0.222

    Declaration

    Swift

    @objc
public var advancedQuery: Bool

  • Array of target fields in message’s data that will be searched with keyword

    Since

    3.0.222

    Declaration

    Swift

    @objc
public var targetFields: [String]?

  • Default constructor

    Declaration

    Swift

    public override init()

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

    Declaration

    Swift

    @objc
public init(builder: (MessageSearchQueryParams) -> Void)

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

Equatable

  • Undocumented

    Declaration

    Swift

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

NSCopying

  • Undocumented

    Declaration

    Swift

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