Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface V2NIMMessageSearchExParams

Hierarchy

  • V2NIMMessageSearchExParams

Index

Properties

conversationId?: string

搜索 “全部会话” 还是搜索 “指定的会话”

  • conversationID 为空(undefined),搜索全部会话
  • conversationID 不为空,搜索指定的会话

检索方向

  • 0 从新到老
  • 1 从老到新
keywordList?: string[]

关键字列表,最多支持 5 个。undefined 和size==0 都表示为空

  • 当消息发送者以及消息类型均未指定时,必须设置关键字列表
  • 否则,关键字列表可以为空
keywordMatchType?: V2NIMSearchKeywordMatchType

关键字列表匹配类型

  • 0:“或” 关系搜索
  • 1:“与” 关系搜索
limit?: number

搜索的数量,最大100

messageSubtypes?: number[]

消息子类型列表

  • 为undefined或空列表, 则表示查询所有消息子类型
  • 关键字不为空时,不支持检索通知类消息
  • 非文本消息,只检索对应检索字段,如果检索字段为空则该消息不会被检索到
messageTypes?: V2NIMMessageType[]

消息类型列表

  • 为undefined或空列表, 则表示查询所有消息类型
  • 关键字不为空时, 不支持检索通知类消息
  • 非文本消息,只检索对应检索字段,如果检索字段为空则该消息不会被检索到
pageToken?: string

搜索的起始位置,第一次填写空字符串,续拉时填写上一次返回的 V2NIMMessageSearchResult 中的 nextPageToken

searchStartTime?: number

搜索开始时间, 默认为 0(从现在开始搜索)。UTC 时间戳,单位:毫秒

searchTimePeriod?: number

从起始时间点开始的过去时间范围,默认为 0(不限制时间范围)。24 x 60 x 60 x 1000 代表过去一天,单位:毫秒

senderAccountIds?: string[]

消息发送者列表,最多支持 5 个。undefined 和size==0 都表示没有指定人数