Options
All
  • Public
  • Public/Protected
  • All
Menu

云端消息全文检索的入参

Hierarchy

  • NIMEFtsMsgLogsOptions

Index

Properties

fromTime?: number

起始时间。默认0,从最早的时候开始查

keyword: string

关键字

msgSubTypeList?: number[]

消息子类型过滤,此类型开发者在发送消息时可自定义,且格式为大于0的整数。示例:[1, 2]

msgTypeList?: ("text" | "image" | "audio" | "video" | "geo" | "notification" | "file" | "tip" | "robot" | "g2" | "custom")[]

消息类型过滤 示例:["text", "image"]

msglogsLimit?: number

消息数量限制。默认 10

orderRule?: "ASC" | "DESC"

查询的方向,以及返回结果的排序方向。默认为 DESC

  • 若选择 ASC,则从开始时间开始查找,直到查到结束时间,或者查到 msglogsLimit 条消息为止。返回结果生序排列
  • 若选择 DESC,则从结束时间开始查找,直到查到开始时间,或者查到 msglogsLimit 条消息为止。返回结果降序排列
p2pSessionList?: string[]

P2P 会话过滤的列表,最大长度 20。传入会话(p2p-accid1)的 account 示例:['accid1', 'accid2', 'accid3']

senderList?: string[]

消息发送者过滤的列表,最大长度 20。account 列表 示例:['accid1', 'accid2', 'accid3']

teamSessionList?: string[]

群会话过滤的列表,最大长度 20。传入群号(team-146694936),示例:['146694936', '13897']

toTime?: number

截止时间。默认0,代表不限制。