Interface MessageLogInterface

options: NIMStrAnyObj

options: { ext?: string; isDeleteRoam?: boolean; isSyncSelf?: boolean; scene: "p2p" | "team" | "superTeam"; to: string; done?: any }

• Optional ext?: string

  扩展字段

• Optional isDeleteRoam?: boolean

  是否删除漫游数据。默认 true

• Optional isSyncSelf?: boolean

  是否多端同步。默认 false

• scene: "p2p" | "team" | "superTeam"

  消息场景

• to: string

  聊天对象。如果当前会话是单聊会话，则传入聊天对象的 IM 账号（accid）；如果当前会话是群聊会话，则传入群 ID。

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj): void

  • done 回调，需开发者自定义。

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    Returns void

options: { done?: any }

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    Returns void

options: { msg: NIMMessage; done?: any }

• msg: NIMMessage

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    Returns void

options: { end?: number; sessionId: string; start?: number; updateSession?: boolean; done?: any }

• Optional end?: number

  结束时间戳

• sessionId: string

  session.id

• Optional start?: number

  开始时间戳

• Optional updateSession?: boolean

  是否同步更新会话，默认 true

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj): void

  • done 回调。该回调需开发者自定义。

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    Returns void

options: { delLastMsg?: boolean; isTag?: boolean; scene: "p2p" | "team" | "superTeam"; to: string; done?: any }

• Optional delLastMsg?: boolean

  是否同时会删除 session.lastMsg。默认 false

• Optional isTag?: boolean

  是否为标记删除，默认 false

  注：为 true 是物理删除，无法能留存为这条消息插入的 localCustom 本地自定义的扩展字段。为 false 是逻辑删除。

• scene: "p2p" | "team" | "superTeam"

  消息场景

• to: string

  聊天对象。若是点对点消息请传入对方的账号，若是群消息则传入群id

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    Returns void

options: { end?: number; start?: number; deletedone?: any; done?: any }

• Optional end?: number

• Optional start?: number

  开始时间戳，不填默认为 0

• deletedone?:function

  • deletedone(data: { deletedMsgCount: number }): void

  • Parameters

    • data: { deletedMsgCount: number }

      • deletedMsgCount: number

    Returns void

• done?:function

  • done(err: null | NIMCommonError | Error, data: null | { deletedMsgCount: number; sessionUpdateCount: number }): void

  • Parameters

    • err: null | NIMCommonError | Error

    • data: null | { deletedMsgCount: number; sessionUpdateCount: number }

    Returns void

options: { asc?: boolean; beginTime?: number; endTime?: number; lastMsgId?: string; limit?: number; msgTypes?: ("custom" | "text" | "image" | "audio" | "video" | "geo" | "notification" | "file" | "tip" | "robot" | "g2")[]; reverse?: boolean; scene: "p2p" | "team" | "superTeam"; to: string; done?: any }

• Optional asc?: boolean

  排序顺序。默认 false

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

  true 表示按时间升序排序

• Optional beginTime?: number

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

• Optional endTime?: number

  结束时间的时间戳. 精确到 ms, 默认为 0

• Optional lastMsgId?: string

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

• Optional limit?: number

  分页查询数量限制，默认 100 条记录

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

  指定消息类型。默认不填写就是查找全部消息类型

• Optional reverse?: boolean

  查询顺序。默认 false 代表降序

  false 从 endTime 开始往前查找 limit 条历史消息

  true 从 beginTime 开始往后查找 limit 条历史消息

• scene: "p2p" | "team" | "superTeam"

  消息场景

• to: string

  聊天对象。若是点对点消息请传入对方的账号，若是群消息则传入群id

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { msgs: NIMMessage[] }): void

  • done 回调，需开发者自定义。

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • data: { msgs: NIMMessage[] }

      • msgs: NIMMessage[]

    Returns void

options: NIMStrAnyObj

options: { desc?: boolean; end?: number; keyword?: string; limit?: number; sessionId?: string; start?: number; subTypes?: number[]; types?: ("custom" | "text" | "image" | "audio" | "video" | "geo" | "notification" | "file" | "tip" | "robot" | "g2")[]; done?: any }

• Optional desc?: boolean

  true 表示从 end 开始查, false 表示从 begin 开始查

• Optional end?: number

  结束时间戳

• Optional keyword?: string

  [indexedDB专用]如果提供参数, 那么查询匹配该关键词的消息

  注：这个参数提供的查询是正向索引模式的，数据量大时查询将会相当慢。若是需要支持全文检索（倒排索引结构）的，参见 fts 相关接口

• Optional limit?: number

  分页限制

• Optional sessionId?: string

  如果提供该参数, 那么查询该会话的消息

• Optional start?: number

  开始时间戳

• Optional subTypes?: number[]

  [indexedDB专用]如果提供该参数, 那么查询这几种子类型的消息

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

  [indexedDB专用]如果提供该参数, 那么查询该类型的消息

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMMessage[]): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • data: NIMMessage[]

    Returns void

options: { idClients: string[]; done?: any }

• idClients: string[]

  客户端为消息生成的 ID 的列表

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMMessage[]): void

  • done 回调，需开发者自定义

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • data: NIMMessage[]

    Returns void

options: { fromTime?: number; keyword: string; msgLimit?: number; msgSubTypeList?: string[]; msgTypeList?: string[]; order?: string; p2pList?: string[]; senderList?: string[]; sessionLimit?: number; teamList?: string[]; toTime?: number; done?: any }

• Optional fromTime?: number

  检索目标的开始时间，默认 0 代表不限制

• keyword: string

  检索关键词

• Optional msgLimit?: number

  单个会话返回的消息数量限制。默认 5。 举例传 1，每个会话返回 1 条匹配的消息。

• Optional msgSubTypeList?: string[]

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

• Optional msgTypeList?: string[]

  消息类型 示例：['text', 'image', 'audio', 'video', 'geo', 'notification', 'file', 'tip', 'custom']

• Optional order?: string

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

• Optional p2pList?: string[]

  搜索条件 P2P 会话列表，会话（p2p-accid1）的 account 示例：['accid1', 'accid2', 'accid3']

• Optional senderList?: string[]

  消息发送者列表，account 列表 示例：['accid1', 'accid2', 'accid3']

• Optional sessionLimit?: number

  会话数量限制。默认 10. 例子：如果传入 5，检索返回 5 个会话的消息

• Optional teamList?: string[]

  搜索条件 群列表。从这些 team（team-146694936） 里搜寻消息，示例：['146694936', '13897']

• Optional toTime?: number

  检索目标的结束时间，默认 当前时间

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMMessage[]): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • data: NIMMessage[]

    Returns void

options: { fromTime?: number; keyword: string; msgLimit?: number; msgSubTypeList?: string[]; msgTypeList?: string[]; order?: string; p2pList?: string[]; senderList?: string[]; teamList?: string[]; toTime?: number; done?: any }

• Optional fromTime?: number

  检索目标的开始时间，默认 0 代表不限制

• keyword: string

  检索关键词

• Optional msgLimit?: number

  单个会话返回的消息数量限制。默认 5。 举例传 1，每个会话返回 1 条匹配的消息。

• Optional msgSubTypeList?: string[]

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

• Optional msgTypeList?: string[]

  消息类型 示例：['text', 'image', 'audio', 'video', 'geo', 'notification', 'file', 'tip', 'custom']

• Optional order?: string

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

• Optional p2pList?: string[]

  搜索条件 P2P 会话列表，会话（p2p-accid1）的 account 示例：['accid1', 'accid2', 'accid3']

• Optional senderList?: string[]

  消息发送者列表，account 列表 示例：['accid1', 'accid2', 'accid3']

• Optional teamList?: string[]

  搜索条件 群列表。从这些 team（team-146694936） 里搜寻消息，示例：['146694936', '13897']

• Optional toTime?: number

  检索目标的结束时间，默认 当前时间

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMMessage[]): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • data: NIMMessage[]

    Returns void

options: { msgs: NIMMessage[]; done?: any }

• msgs: NIMMessage[]

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj): void

  • Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    Returns void

options: NIMStrAnyObj

options: { msg: NIMMessage; done?: any }

• msg: NIMMessage

  待查询的消息

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, messageArr: NIMMessage[]): void

  • 回调，第二个回调参数是消息列表

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • messageArr: NIMMessage[]

    Returns void

options: { msg: NIMMessage; done?: any }

• msg: NIMMessage

  待查询的消息

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, count: number): void

  • 回调，第二个回调参数是所有回复消息数量

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • count: number

    Returns void

options: { idClient: string; localCustom: string; done?: any }

• idClient: string

  客户端为消息生成的 ID

• localCustom: string

  本地自定义扩展字段

• done?:function

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMMessage[]): void

  • done 回调，需开发者自定义

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj

    • data: NIMMessage[]

    Returns void