Options
All
  • Public
  • Public/Protected
  • All
Menu

Module MsgLogServiceInterface

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

ClearHistoryMsgsFromServerOptions

ClearHistoryMsgsFromServerOptions: { ext?: string; isSyncSelf?: boolean; scene: TMsgScene; to: string }

Type declaration

  • Optional ext?: string

    扩展字段

  • Optional isSyncSelf?: boolean

    是否多端同步

  • scene: TMsgScene
  • to: string

GetHistoryMsgsOptions

GetHistoryMsgsOptions: { asc?: boolean; beginTime?: number; endTime?: number; lastMsgId?: string; limit?: number; msgTypes?: TMsgType[]; reverse?: boolean; scene: TMsgScene; to: string }

Type declaration

  • Optional asc?: boolean

    是否为升序排序

    false 表示返回的消息按时间降序排序; true 表示按时间升序排序

  • Optional beginTime?: number

    开始时间戳, 精确到 ms, 默认为 0

  • Optional endTime?: number

    结束时间戳, 精确到 ms, 默认为服务器的当前时间

  • Optional lastMsgId?: string

    上次查询的最后一条消息的 idServer, 第一次不填

  • Optional limit?: number

    本次查询的消息数量限制, 最多 100 条, 默认 100 条

  • Optional msgTypes?: TMsgType[]

    消息类型列表，默认全部消息类型

  • Optional reverse?: boolean

    是否为反向查询，默认 false

    false 表示从 endTime 开始往前查找历史消息; true 表示从 beginTime 开始往后查找历史消息

  • scene: TMsgScene

    场景

  • to: string

    聊天对象, 账号或者群id

NIMEFtsCloudMsgLogsAggWithSessionOptions

NIMEFtsCloudMsgLogsAggWithSessionOptions: { fromTime?: number; keyword: string; msgSubTypeList?: number[]; msgTypeList?: EMsgType[]; msglogsLimit?: number; orderRule?: NIMEnumFtsMsgLogsOrder; p2pSessionList?: string[]; senderList?: string[]; sessionLimit?: number; teamSessionList?: string[]; toTime?: number }

云端消息全文检索(按会话进行聚合)的接口入参定义

Type declaration

  • Optional fromTime?: number

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

  • keyword: string

    关键字

  • Optional msgSubTypeList?: number[]

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

  • Optional msgTypeList?: EMsgType[]

    消息类型过滤 示例：[EMsgType.text, EMsgType.image]

  • Optional msglogsLimit?: number

    单个会话返回的消息数量限制。默认 5

  • Optional orderRule?: NIMEnumFtsMsgLogsOrder

    查询的时间排序规则。默认 NIMEnumFtsMsgLogsOrder.DESC 按消息时间降序。可选 NIMEnumFtsMsgLogsOrder.ASC 升序

  • Optional p2pSessionList?: string[]

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

  • Optional senderList?: string[]

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

  • Optional sessionLimit?: number

    返回的最大会话数量限制。默认 10

  • Optional teamSessionList?: string[]

    群会话过滤的列表，最大长度 20。传入群号（team-146694936），示例：['146694936', '13897']

  • Optional toTime?: number

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

NIMEFtsMsgLogsOptions

NIMEFtsMsgLogsOptions: { fromTime?: number; keyword: string; msgSubTypeList?: number[]; msgTypeList?: EMsgType[]; msglogsLimit?: number; orderRule?: NIMEnumFtsMsgLogsOrder; p2pSessionList?: string[]; senderList?: string[]; teamSessionList?: string[]; toTime?: number }

云端消息全文检索的入参

Type declaration

  • Optional fromTime?: number

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

  • keyword: string

    关键字

  • Optional msgSubTypeList?: number[]

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

  • Optional msgTypeList?: EMsgType[]

    消息类型过滤 示例：[EMsgType.text, EMsgType.image]

  • Optional msglogsLimit?: number

    消息数量限制。默认 10

  • Optional orderRule?: NIMEnumFtsMsgLogsOrder

    查询的时间排序规则。默认 NIMEnumFtsMsgLogsOrder.DESC 按消息时间降序。可选 NIMEnumFtsMsgLogsOrder.ASC 升序

  • Optional p2pSessionList?: string[]

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

  • Optional senderList?: string[]

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

  • Optional teamSessionList?: string[]

    群会话过滤的列表，最大长度 20。传入群号（team-146694936），示例：['146694936', '13897']

  • Optional toTime?: number

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

SessionIdListOptions

SessionIdListOptions: { ids: string[] }

Type declaration

  • ids: string[]

    sessionId 数组

    例如 p2p-cs1、team-113879441