NIMMessageSearchOption Class Reference

Inherits from NSObject
Declared in NIMMessageSearchOption.h

Overview

Local search option

Search condition: Date range: (startTime,endTime), type: messageTypes or all types and match searchContent or fromIds

  startTime

The start time. The default value is 0

@property (nonatomic, assign) NSTimeInterval startTime

Discussion

The start time. The default value is 0

Declared In

NIMMessageSearchOption.h

  endTime

The end time. the default value is 0

@property (nonatomic, assign) NSTimeInterval endTime

Discussion

The end time. the default value is 0

The end time of the search. A value of 0 indiates the maximum timestamp allowed.

Declared In

NIMMessageSearchOption.h

  limit

Search limit

@property (nonatomic, assign) NSUInteger limit

Discussion

Search limit

The default value is 100. A value of 0 indicates no limit

Declared In

NIMMessageSearchOption.h

  order

Search order

@property (nonatomic, assign) NIMMessageSearchOrder order

Discussion

Search order

Declared In

NIMMessageSearchOption.h

  messageTypes

The message type for search @discusssion message types. only text messages are ready for search by default and allMessageTypes is set to NO. Value range: NIMMessageType enumerations

@property (nonatomic, copy) NSArray<NSNumber*> *messageTypes

Discussion

The message type for search @discusssion message types. only text messages are ready for search by default and allMessageTypes is set to NO. Value range: NIMMessageType enumerations

Declared In

NIMMessageSearchOption.h

  messageSubTypes

The message subtypes for search @discusssion message subtypes

@property (nonatomic, strong) NSArray<NSNumber*> *messageSubTypes

Discussion

The message subtypes for search @discusssion message subtypes

Declared In

NIMMessageSearchOption.h

  allMessageTypes

All message types

@property (nonatomic, assign) BOOL allMessageTypes

Discussion

All message types

The default value is NO

Declared In

NIMMessageSearchOption.h

  searchContent

Search text messages

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

Discussion

Search text messages

Declared In

NIMMessageSearchOption.h

  fromIds

List of accounts that sent messages

@property (nullable, nonatomic, copy) NSArray<NSString*> *fromIds

Discussion

List of accounts that sent messages

Declared In

NIMMessageSearchOption.h

  enableContentTransfer

Convert special characters using regex. The default value: YES.

@property (nonatomic, assign) BOOL enableContentTransfer

Discussion

Convert special characters using regex. The default value: YES.

Declared In

NIMMessageSearchOption.h