-
Notifications
You must be signed in to change notification settings - Fork 2
nim.msglog.NIMMsgLog
nim/msglog.NIMMsgLog
-
EventEmitter<NIMMsgLogEvents>↳
NIMMsgLog
- eventNames
- listeners
- listenerCount
- emit
- on
- addListener
- once
- removeListener
- off
- removeAllListeners
- initEventHandlers
- queryMsgByIDAysnc
- queryMsgAsync
- getMessagesDynamically
- queryMsgOnlineAsync
- queryMsgByKeywordOnlineAsync
- queryMsgOfSpecifiedTypeInASessionAsync
- queryMsgByOptionsAsync
- batchStatusReadAsync
- batchStatusDeleteAsync
- setStatusAsync
- setSubStatusAsync
- writeMsglogToLocalAsync
- deleteBySessionTypeAsync
- deleteAsync
- deleteAllAsync
- deleteMsgByTimeAsync
- exportDbAsync
- importDbAsync
- sendReceiptAsync
- querySentMessageBeReaded
- queryReceivedMsgReceiptSent
- updateLocalExtAsync
- readAllAsync
- exportBackupToRemote
- importBackupToRemote
- cancelImportBackupFromRemote
- cancelExportBackupToRemote
- deleteHistoryOnlineAsync
- deleteHistoryOnlineAsyncEx
- deleteMessageSelfAsync
- queryMessageIsThreadRoot
- queryMessageOnline
- queryThreadHistoryMsg
- fullTextSearchOnlineAsync
▸ eventNames(): keyof NIMMsgLogEvents[]
Return an array listing the events for which the emitter has registered listeners.
keyof NIMMsgLogEvents[]
EventEmitter.eventNames
node_modules/eventemitter3/index.d.ts:15
▸ listeners<T>(event): (...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void[]
Return the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
(...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void[]
EventEmitter.listeners
node_modules/eventemitter3/index.d.ts:20
▸ listenerCount(event): number
Return the number of listeners listening to a given event.
| Name | Type |
|---|---|
event |
keyof NIMMsgLogEvents
|
number
EventEmitter.listenerCount
node_modules/eventemitter3/index.d.ts:27
▸ emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
...args |
ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>] |
boolean
EventEmitter.emit
node_modules/eventemitter3/index.d.ts:32
▸ on<T>(event, fn, context?): NIMMsgLog
Add a listener for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void
|
context? |
any |
EventEmitter.on
node_modules/eventemitter3/index.d.ts:40
▸ addListener<T>(event, fn, context?): NIMMsgLog
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void
|
context? |
any |
EventEmitter.addListener
node_modules/eventemitter3/index.d.ts:45
▸ once<T>(event, fn, context?): NIMMsgLog
Add a one-time listener for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void
|
context? |
any |
EventEmitter.once
node_modules/eventemitter3/index.d.ts:54
▸ removeListener<T>(event, fn?, context?, once?): NIMMsgLog
Remove the listeners of a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.removeListener
node_modules/eventemitter3/index.d.ts:63
▸ off<T>(event, fn?, context?, once?): NIMMsgLog
| Name | Type |
|---|---|
T |
extends keyof NIMMsgLogEvents
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<NIMMsgLogEvents>[Extract<T, keyof NIMMsgLogEvents>]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.off
node_modules/eventemitter3/index.d.ts:69
▸ removeAllListeners(event?): NIMMsgLog
Remove all listeners, or those of the specified event.
| Name | Type |
|---|---|
event? |
keyof NIMMsgLogEvents
|
EventEmitter.removeAllListeners
node_modules/eventemitter3/index.d.ts:79
▸ initEventHandlers(): void
注册全局回调
void
ts/nim/msglog.ts:59
▸ queryMsgByIDAysnc(clientMsgId, cb, jsonExtension): Promise<null | [NIMResCode, string, IMMessage]>
根据消息ID查询本地（单条）消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
clientMsgId |
string |
客户端消息ID |
cb |
null | QuerySingleMsgCallback
|
查询本地消息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string, IMMessage]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:73
▸ queryMsgAsync(accid, to_type, limit_count, anchor_msg_time, cb, jsonExtension): Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
查询本地消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
accid |
string |
查询id，account_id/uid或者tid |
to_type |
NIMSessionType |
会话类型，双人0，群组1 (见nim_msglog_def.h) |
limit_count |
number |
一次查询数量，建议20 |
anchor_msg_time |
number |
作为此次查询的定位点的消息历史的消息时间戳（上次查询最后一条消息的时间戳，按指定的时间的顺序起查，默认为逆序，2.4.0之前命名为last_name） |
cb |
null | QueryMsgCallback
|
查询本地消息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:106
▸ getMessagesDynamically(session_id, to_type, from_time, to_time, limit_count, anchor_client_msg_id, anchor_server_msg_id, direction, cb, jsonExtension): Promise<null | [GetMessagesResult]>
查询历史消息，基于本地可信时间段信息来动态判断获取消息的途径
Note
错误码 200:成功
| Name | Type | Description |
|---|---|---|
session_id |
string |
会话id |
to_type |
NIMSessionType |
会话类型, 双人0，群组1, 超大群5 |
from_time |
number |
开始时间, 包含 |
to_time |
number |
结束时间, 大于from_time, 0表示当前时间; 只有在direction为kForward且anchor_client_msg_id不为空时才包含 |
limit_count |
number |
查询数量 |
anchor_client_msg_id |
string |
查询起始的客户端消息id, 查询结果不包括这条消息 |
anchor_server_msg_id |
string |
查询起始的服务器消息id, 查询结果不包括这条消息 |
direction |
NIMMsglogSearchDirection |
查询方向 |
cb |
null | GetMessagesDynamicallyCallback
|
查询消息的回调函数 |
jsonExtension |
string |
- |
Promise<null | [GetMessagesResult]>
void
ts/nim/msglog.ts:149
▸ queryMsgOnlineAsync(param, cb): Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
在线查询消息（不包括系统消息）
Note
200:成功 403:禁止访问(不在该群,只针对群组会话) 414:参数错误
| Name | Type | Description |
|---|---|---|
param |
QueryMsgOnlineAsyncParam |
查询参数 |
cb |
null | QueryMsgCallback
|
在线查询消息的回调函数 |
Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:193
▸ queryMsgByKeywordOnlineAsync(param, cb): Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
在线查询消息（不包括系统消息）
Note
200:成功 403:禁止访问(不在该群,只针对群组会话) 414:参数错误
| Name | Type | Description |
|---|---|---|
param |
QueryMsgByKeywordOnlineParam |
查询参数 |
cb |
null | QueryMsgCallback
|
在线查询消息的回调函数 |
Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:219
▸ queryMsgOfSpecifiedTypeInASessionAsync(to_type, id, limit_count, fromTime, endTime, endClientMsgId, reverse, msgType, cb, jsonExtension): Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
根据指定条件在一个会话中查询指定单个或多个类型的本地消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
to_type |
NIMSessionType |
会话类型，双人0，群组1 (nim_msglog_def.h) |
id |
string |
查询id，对方的account id或者群组tid。 |
limit_count |
number |
本次查询的消息条数上限(最多100条) |
fromTime |
number |
起始时间点，单位：毫秒 |
endTime |
number |
结束时间点，单位：毫秒 |
endClientMsgId |
string |
结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中) |
reverse |
boolean |
true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false） |
msgType |
NIMMessageType[] |
检索的消息类型 |
cb |
null | QueryMsgCallback
|
在线查询消息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:254
▸ queryMsgByOptionsAsync(param, cb): Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册
Note
200:成功
| Name | Type | Description |
|---|---|---|
param |
QueryMsgByOptionsAsyncParam |
查询参数 |
cb |
null | QueryMsgCallback
|
在线查询消息的回调函数 |
Promise<null | [NIMResCode, string, NIMSessionType, QueryMsglogResult]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:300
▸ batchStatusReadAsync(accid, to_type, cb, jsonExtension): Promise<null | [NIMResCode, string, NIMSessionType]>
批量设置已读状态
Note
200:成功
| Name | Type | Description |
|---|---|---|
accid |
string |
查询id，account_id/uid或者tid |
to_type |
NIMSessionType |
会话类型，双人0，群组1 (见nim_msglog_def.h) |
cb |
null | ModifyMultipleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string, NIMSessionType]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:329
▸ batchStatusDeleteAsync(accid, to_type, revert_by_query_online, cb, jsonExtension): Promise<null | [NIMResCode, string, NIMSessionType]>
删除某个会话的全部聊天记录
Note
200:成功
| Name | Type | Description |
|---|---|---|
accid |
string |
要删除会话的id，account_id/uid或者tid |
to_type |
NIMSessionType |
会话类型，双人0，群组1 (见nim_msglog_def.h) |
revert_by_query_online |
boolean |
是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否 |
cb |
null | ModifyMultipleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string, NIMSessionType]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:366
▸ setStatusAsync(msg_id, status, cb, jsonExtension): Promise<null | [NIMResCode, string]>
设置消息状态
Note
200:成功
| Name | Type | Description |
|---|---|---|
msg_id |
string |
消息id |
status |
NIMMsgLogStatus |
消息状态枚举值 |
cb |
null | ModifySingleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:404
▸ setSubStatusAsync(msg_id, status, cb, jsonExtension): Promise<null | [NIMResCode, string]>
设置消息子状态
Note
200:成功
| Name | Type | Description |
|---|---|---|
msg_id |
string |
消息id |
status |
NIMMsgLogSubStatus |
消息子状态枚举值 |
cb |
null | ModifySingleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:440
▸ writeMsglogToLocalAsync(talkId, msg, needUpdateSession, composeLastMsg, excludeMsgType, cb): Promise<null | [NIMResCode, string]>
只往本地消息历史数据库里写入一条消息（如果已存在这条消息，则更新。通常是APP的本地自定义消息，并不会发给服务器）
Note
200:成功
| Name | Type | Description |
|---|---|---|
talkId |
string |
会话id，对方的account id或者群组tid |
msg |
IMMessage |
消息内容 |
needUpdateSession |
boolean |
是否更新会话列表（一般最新一条消息有这个需求） |
composeLastMsg |
boolean |
如果消息历史中有该会话的消息，是否将该会话最后一条消息随会话变更上报，true 为携带，否则不携带 |
excludeMsgType |
number[] |
如果 compose_last_msg = true，则可根据需要排除指定最后一条消息的类型 |
cb |
null | ModifySingleMsglogCallback
|
操作结果的回调函数 |
Promise<null | [NIMResCode, string]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:478
▸ deleteBySessionTypeAsync(delSessions, to_type, revert_by_query_online, cb, jsonExtension): Promise<null | [NIMResCode, string, NIMSessionType]>
删除指定会话类型的所有消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
delSessions |
boolean |
是否删除会话 |
to_type |
NIMSessionType |
会话类型 |
revert_by_query_online |
boolean |
是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否 |
cb |
null | ModifyMultipleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string, NIMSessionType]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:512
▸ deleteAsync(session_id, to_type, msg_id, cb, jsonExtension): Promise<null | [NIMResCode, string]>
删除指定一条消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
session_id |
string |
会话id，对方的account id或者群组tid |
to_type |
NIMSessionType |
会话类型 |
msg_id |
string |
消息id |
cb |
null | ModifySingleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode, string]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:551
▸ deleteAllAsync(del_session, revert_by_query_online, cb, jsonExtension): Promise<null | [NIMResCode]>
删除全部消息历史
Note
200:成功
| Name | Type | Description |
|---|---|---|
del_session |
boolean |
是否删除所有会话列表项（即全部最近联系人）。 ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件（不会触发每个会话项的kNIMSessionCommandRemove事件）； false则不删除，并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSession CommandAllMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。 |
revert_by_query_online |
boolean |
是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否 |
cb |
null | DBFunctionCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:592
▸ deleteMsgByTimeAsync(session_id, to_type, revert_by_query_online, timestamp1, timestamp2, cb, jsonExtension): Promise<null | [NIMResCode]>
根据时间段删除部分会话的历史消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
session_id |
string |
要删除消息的会话ID |
to_type |
NIMSessionType |
要删除消息的会话类型 |
revert_by_query_online |
boolean |
是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否 |
timestamp1 |
number |
单位ms timestamp1 与 timestamp2 组成一个时间段，SDK 内部会判断大小调整入参顺序 |
timestamp2 |
number |
单位ms timestamp2 与 timestamp1 组成一个时间段，SDK 内部会判断大小调整入参顺序 |
cb |
null | DBFunctionCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<null | [NIMResCode]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:626
▸ exportDbAsync(dst_path, cb, jsonExtension): Promise<[NIMResCode]>
导出整个消息历史DB文件（不包括系统消息历史）
Note
200:成功
| Name | Type | Description |
|---|---|---|
dst_path |
string |
导出时保存的目标全路径（UTF-8编码）。 |
cb |
null | DBFunctionCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<[NIMResCode]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:667
▸ importDbAsync(src_path, cb, prg_cb, jsonExtension): Promise<[NIMResCode]>
导入消息历史DB文件（不包括系统消息历史）。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey），如果验证不通过，则不导入。
Note
200:成功 10600:导入消息历史时验证身份和加密密钥不通过 10601:导入消息历史时写记录失败
| Name | Type | Description |
|---|---|---|
src_path |
string |
导入源文件的全路径（UTF-8编码）。 |
cb |
DBFunctionCallback |
操作结果的回调函数 |
prg_cb |
null | ImportDbPrgCallback
|
导入进度的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<[NIMResCode]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:695
▸ sendReceiptAsync(msg, cb): Promise<[MessageStatusChangedResult]>
发送消息已读回执
Note
200:成功 403:服务器关闭此功能，或者应用没权限 404:请求的目标（用户或对象）不存在 10414:本地错误码，参数错误
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
已读消息 |
cb |
null | MessageStatusChangedCallback
|
操作结果的回调函数 |
Promise<[MessageStatusChangedResult]>
void 无返回值
ts/nim/msglog.ts:723
▸ querySentMessageBeReaded(msg): boolean
查询自己发送的消息是否被对方已读
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
消息。 |
boolean
boolean 是否被已读
ts/nim/msglog.ts:738
▸ queryReceivedMsgReceiptSent(msg): boolean
查询收到的消息是否已经发送过已读回执
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
消息。 |
boolean
boolean 是否已发送过
ts/nim/msglog.ts:746
▸ updateLocalExtAsync(msg_id, local_ext, cb, jsonExtension): Promise<[NIMResCode, string]>
更新本地消息扩展字段内容
Note
200:成功
| Name | Type | Description |
|---|---|---|
msg_id |
string |
消息id |
local_ext |
string |
本地扩展字段内容 |
cb |
null | ModifySingleMsglogCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<[NIMResCode, string]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:761
▸ readAllAsync(cb, jsonExtension): Promise<[NIMResCode]>
全部未读消息历史标记为已读
Note
200:成功
| Name | Type | Description |
|---|---|---|
cb |
null | DBFunctionCallback
|
操作结果的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
Promise<[NIMResCode]>
boolean 检查参数如果不符合要求则返回失败
ts/nim/msglog.ts:786
▸ exportBackupToRemote(export_info): boolean
导出本地消息记录到云端
| Name | Type | Description |
|---|---|---|
export_info |
LogsBackupExportInfo |
导出需要的参数参考LogsBackupExportInfo定义 |
boolean
boolean false : 当前有导入/导出操作正在进行中
ts/nim/msglog.ts:801
▸ importBackupToRemote(export_info): boolean
导入已备份在云端的消息记录
| Name | Type |
|---|---|
export_info |
LogsBackupImportInfo |
boolean
boolean false : 当前有导入/导出操作正在进行中
ts/nim/msglog.ts:809
▸ cancelImportBackupFromRemote(): void
取消导入已备份在云端的消息记录
void
void
ts/nim/msglog.ts:816
▸ cancelExportBackupToRemote(): void
取消导出本地消息记录到云端
void
void
ts/nim/msglog.ts:823
▸ deleteHistoryOnlineAsync(accid, del_remote, jsonExtension, cb): Promise<[NIMResCode, string]>
删除与某账号的所有云端历史记录与漫游消息(p2p)
Note
200:成功
| Name | Type | Description |
|---|---|---|
accid |
string |
对方的accid |
del_remote |
boolean |
是否同时删除所有的漫游消息 true : 是 false : 否 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
cb |
null | DeleteHistoryOnLineAsyncCallback
|
操作结果的回调函数 |
Promise<[NIMResCode, string]>
void
ts/nim/msglog.ts:838
▸ deleteHistoryOnlineAsyncEx(accid, to_type, needs_notify_self, jsonExtension, cb): Promise<[NIMResCode, string, number, number, string]>
删除某一会话的云端的历史记录[v8.0.0]
Note
错误码 200:成功
| Name | Type | Description |
|---|---|---|
accid |
string |
对方的accid(p2p:accid team:tid) |
to_type |
number |
会话类型，双人0，群组1 (见nim_msglog_def.h) |
needs_notify_self |
boolean |
是否通知其它终端 |
jsonExtension |
string |
扩展字段 |
cb |
null | DeleteHistoryOnLineAsyncExCallback
|
操作结果的回调函数 |
Promise<[NIMResCode, string, number, number, string]>
void
ts/nim/msglog.ts:863
▸ deleteMessageSelfAsync(msg, ext, cb): Promise<[NIMResCode]>
单向删除某条消息记录(同时删除本地与云端)
Note
200:成功
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
要删除的消息 |
ext |
string |
- |
cb |
null | DeleteMessageSelfAsyncCallback
|
操作结果的回调函数 |
Promise<[NIMResCode]>
void 无返回值
ts/nim/msglog.ts:890
▸ queryMessageIsThreadRoot(client_id, cb): Promise<[NIMResCode, string, boolean]>
查询某条消息是否为thread聊天的根消息
Note
200:成功
| Name | Type | Description |
|---|---|---|
client_id |
string |
要查询的消息的客户端ID |
cb |
null | QueryMessageIsThreadRootCallback
|
操作结果的回调函数 |
Promise<[NIMResCode, string, boolean]>
void 无返回值
ts/nim/msglog.ts:910
▸ queryMessageOnline(param, cb): Promise<[NIMResCode, string, IMMessage]>
查询某条消息的具体内容一般用在thread talk 场景中
Note
200:成功
| Name | Type | Description |
|---|---|---|
param |
QueryMsgAsyncParam |
要查询的消息的相关参数，可以在msglog.threadinfo中得到 |
cb |
null | QueryMessageOnlineCallback
|
查询结果的回调函数 |
Promise<[NIMResCode, string, IMMessage]>
void 无返回值
ts/nim/msglog.ts:930
▸ queryThreadHistoryMsg(msg, param, cb): Promise<[NIMResCode, IMMessage, number, number, IMMessage[]]>
分页查询thread talk消息历史
Note
200:成功
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
要查询的消息 |
param |
QueryThreadHistoryMsgAsyncParam |
要查询的消息的相关参数，可以在msglog.threadinfo中得到 |
cb |
null | QueryThreadHistoryMsgCallback
|
查询结果的回调函数 |
Promise<[NIMResCode, IMMessage, number, number, IMMessage[]]>
void 无返回值
ts/nim/msglog.ts:951
▸ fullTextSearchOnlineAsync(param, cb): Promise<[NIMResCode, QueryMsglogResult]>
在线全文检索
Note
200:成功
| Name | Type | Description |
|---|---|---|
param |
FullTextSearchOnlineAsyncParam |
全文检索参数 |
cb |
null | FullTextSearchOnlineAsyncCallback
|
全文检索结果回调函数 |
Promise<[NIMResCode, QueryMsglogResult]>
void 无返回值
ts/nim/msglog.ts:975
• msglog: NIMMsgLogAPI
ts/nim/msglog.ts:52
• new NIMMsgLog()
EventEmitter<NIMMsgLogEvents>.constructor
ts/nim/msglog.ts:53
- chatroom/chatroom
- chatroom_def/chatroom_def
- nim/client
- nim/data_sync
- nim/friend
- nim/global
- nim/msglog
- nim/nos
- nim/online_session
- nim/pass_through_proxy
- nim/plugin
- nim/session
- nim/subscribe_event
- nim/super_team
- nim/sysmsg
- nim/talk
- nim/talkex
- nim/team
- nim/tool
- nim/user
- nim_def/client_def
- nim_def/data_sync_def
- nim_def/doc_trans_def
- nim_def/friend_def
- nim_def/global_def
- nim_def/msglog_def
- nim_def/nos_def
- nim_def/online_session_def
- nim_def/pass_through_proxy_def
- nim_def/plugin_def
- nim_def/session_def
- nim_def/subscribe_event_def
- nim_def/super_team_def
- nim_def/sysmsg_def
- nim_def/talk_def
- nim_def/talkex_def
- nim_def/team_def
- nim_def/tool_def
- nim_def/user_def
- node-nim
- qchat/attachment
- qchat/channel
- qchat/channel_category
- qchat/instance
- qchat/message
- qchat/role
- qchat/server
- qchat/system_notification
- qchat_def/attachment_def
- qchat_def/channel_def
- qchat_def/instance_def
- qchat_def/message_def
- qchat_def/public_def
- qchat_def/role_def
- qchat_def/server_def
- qchat_def/system_notification_def