SBDMessageSearchQueryBuilder Class Reference

Inherits from NSObject
Declared in SBDMessageSearchQuery.h

Overview

A Builder class to build a SBDMessageSearchQuery

  keyword

Keyword to search for.

@property (nonatomic, copy, nullable) NSString *keyword

Declared In

SBDMessageSearchQuery.h

  channelUrl

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

@property (nonatomic, copy, nullable) NSString *channelUrl

Declared In

SBDMessageSearchQuery.h

  channelCustomType

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

@property (nonatomic, copy, nullable) NSString *channelCustomType

Declared In

SBDMessageSearchQuery.h

  reverse

Should reverse the queried result list. Default is false

@property (nonatomic, assign) BOOL reverse

Declared In

SBDMessageSearchQuery.h

  exactMatch

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

@property (nonatomic, assign) BOOL exactMatch

Declared In

SBDMessageSearchQuery.h

  limit

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

@property (nonatomic, assign) NSUInteger limit

Declared In

SBDMessageSearchQuery.h

  messageTimestampFrom

Starting timestamp to search from. Default is 0

@property (nonatomic, assign) long long messageTimestampFrom

Declared In

SBDMessageSearchQuery.h

  messageTimestampTo

Ending timestamp to search to Default is 0

@property (nonatomic, assign) long long messageTimestampTo

Declared In

SBDMessageSearchQuery.h

  order

The order method for the search. It is defined in SBDMessageSearchQueryOrder.

@property (nonatomic, assign) SBDMessageSearchQueryOrder order

Declared In

SBDMessageSearchQuery.h

  advancedQuery

Whether treat keyword field as advanced query or not

@property (nonatomic, assign) BOOL advancedQuery

Availability

3.0.222

Declared In

SBDMessageSearchQuery.h

  targetFields

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

@property (nonatomic, strong, nullable) NSArray<NSString*> *targetFields

Availability

3.0.222

Declared In

SBDMessageSearchQuery.h