nim_def.msglog_def.NIMMsgLogAPI

Interface: NIMMsgLogAPI

nim_def/msglog_def.NIMMsgLogAPI

Table of contents

Methods

• InitEventHandlers
• QueryMsgByIDAysnc
• QueryMsgAsync
• 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

Methods

InitEventHandlers

▸ InitEventHandlers(): void

Returns

void

Defined in

ts/nim_def/msglog_def.ts:361

---

QueryMsgByIDAysnc

▸ QueryMsgByIDAysnc(clientMsgId, cb, jsonExtension): boolean

Parameters

Name	Type
clientMsgId	string
cb	null | QuerySingleMsgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:363

---

QueryMsgAsync

▸ QueryMsgAsync(accid, to_type, limit_count, anchor_msg_time, cb, jsonExtension): boolean

Parameters

Name	Type
accid	string
to_type	NIMSessionType
limit_count	number
anchor_msg_time	number
cb	null | QueryMsgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:365

---

QueryMsgOnlineAsync

▸ QueryMsgOnlineAsync(param, cb): boolean

Parameters

Name	Type
param	QueryMsgOnlineAsyncParam
cb	null | QueryMsgCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:374

---

QueryMsgByKeywordOnlineAsync

▸ QueryMsgByKeywordOnlineAsync(param, cb): boolean

Parameters

Name	Type
param	QueryMsgByKeywordOnlineParam
cb	null | QueryMsgCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:376

---

QueryMsgOfSpecifiedTypeInASessionAsync

▸ QueryMsgOfSpecifiedTypeInASessionAsync(to_type, id, limit_count, fromTime, endTime, endClientMsgId, reverse, msgType, cb, jsonExtension): boolean

Parameters

Name	Type
to_type	NIMSessionType
id	string
limit_count	number
fromTime	number
endTime	number
endClientMsgId	string
reverse	boolean
msgType	NIMMessageType[]
cb	null | QueryMsgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:378

---

QueryMsgByOptionsAsync

▸ QueryMsgByOptionsAsync(param, cb): boolean

Parameters

Name	Type
param	QueryMsgByOptionsAsyncParam
cb	null | QueryMsgCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:391

---

BatchStatusReadAsync

▸ BatchStatusReadAsync(accid, to_type, cb, jsonExtension): boolean

Parameters

Name	Type
accid	string
to_type	NIMSessionType
cb	null | ModifyMultipleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:393

---

BatchStatusDeleteAsync

▸ BatchStatusDeleteAsync(accid, to_type, revert_by_query_online, cb, jsonExtension): boolean

Parameters

Name	Type
accid	string
to_type	NIMSessionType
revert_by_query_online	boolean
cb	null | ModifyMultipleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:395

---

SetStatusAsync

▸ SetStatusAsync(msg_id, status, cb, jsonExtension): boolean

Parameters

Name	Type
msg_id	string
status	NIMMsgLogStatus
cb	null | ModifySingleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:403

---

SetSubStatusAsync

▸ SetSubStatusAsync(msg_id, status, cb, jsonExtension): boolean

Parameters

Name	Type
msg_id	string
status	NIMMsgLogSubStatus
cb	null | ModifySingleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:405

---

WriteMsglogToLocalAsync

▸ WriteMsglogToLocalAsync(talkId, msg, needUpdateSession, composeLastMsg, excludeMsgType, cb): boolean

Parameters

Name	Type
talkId	string
msg	IMMessage
needUpdateSession	boolean
composeLastMsg	boolean
excludeMsgType	number[]
cb	null | ModifySingleMsglogCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:407

---

DeleteBySessionTypeAsync

▸ DeleteBySessionTypeAsync(delSessions, to_type, revert_by_query_online, cb, jsonExtension): boolean

Parameters

Name	Type
delSessions	boolean
to_type	NIMSessionType
revert_by_query_online	boolean
cb	null | ModifyMultipleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:416

---

DeleteAsync

▸ DeleteAsync(session_id, to_type, msg_id, cb, jsonExtension): boolean

Parameters

Name	Type
session_id	string
to_type	NIMSessionType
msg_id	string
cb	null | ModifySingleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:424

---

DeleteAllAsync

▸ DeleteAllAsync(del_session, revert_by_query_online, cb, jsonExtension): boolean

Parameters

Name	Type
del_session	boolean
revert_by_query_online	boolean
cb	null | DBFunctionCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:426

---

DeleteMsgByTimeAsync

▸ DeleteMsgByTimeAsync(session_id, to_type, revert_by_query_online, timestamp1, timestamp2, cb, jsonExtension): boolean

Parameters

Name	Type
session_id	string
to_type	NIMSessionType
revert_by_query_online	boolean
timestamp1	number
timestamp2	number
cb	null | DBFunctionCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:428

---

ExportDbAsync

▸ ExportDbAsync(dst_path, cb, jsonExtension): boolean

Parameters

Name	Type
dst_path	string
cb	null | DBFunctionCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:438

---

ImportDbAsync

▸ ImportDbAsync(src_path, db_cb, prg_cb, jsonExtension): boolean

Parameters

Name	Type
src_path	string
db_cb	DBFunctionCallback
prg_cb	null | ImportDbPrgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:440

---

SendReceiptAsync

▸ SendReceiptAsync(msg, cb): void

Parameters

Name	Type
msg	IMMessage
cb	null | MessageStatusChangedCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:442

---

QuerySentMessageBeReaded

▸ QuerySentMessageBeReaded(msg): boolean

Parameters

Name	Type
msg	IMMessage

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:444

---

QueryReceivedMsgReceiptSent

▸ QueryReceivedMsgReceiptSent(msg): boolean

Parameters

Name	Type
msg	IMMessage

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:446

---

UpdateLocalExtAsync

▸ UpdateLocalExtAsync(msg_id, local_ext, cb, jsonExtension): boolean

Parameters

Name	Type
msg_id	string
local_ext	string
cb	null | ModifySingleMsglogCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:448

---

ReadAllAsync

▸ ReadAllAsync(cb, jsonExtension): boolean

Parameters

Name	Type
cb	null | DBFunctionCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:450

---

ExportBackupToRemote

▸ ExportBackupToRemote(export_info): boolean

Parameters

Name	Type
export_info	LogsBackupExportInfo

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:452

---

ImportBackupToRemote

▸ ImportBackupToRemote(export_info): boolean

Parameters

Name	Type
export_info	LogsBackupImportInfo

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:454

---

CancelImportBackupFromRemote

▸ CancelImportBackupFromRemote(): void

Returns

void

Defined in

ts/nim_def/msglog_def.ts:456

---

CancelExportBackupToRemote

▸ CancelExportBackupToRemote(): void

Returns

void

Defined in

ts/nim_def/msglog_def.ts:458

---

DeleteHistoryOnlineAsync

▸ DeleteHistoryOnlineAsync(accid, delete_roaming, jsonExtension, cb): void

Parameters

Name	Type
accid	string
delete_roaming	boolean
jsonExtension	string
cb	null | DeleteHistoryOnLineAsyncExCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:460

---

DeleteHistoryOnlineAsyncEx

▸ DeleteHistoryOnlineAsyncEx(accid, to_type, needs_notify_self, jsonExtension, cb): void

Parameters

Name	Type
accid	string
to_type	number
needs_notify_self	boolean
jsonExtension	string
cb	null | DeleteHistoryOnLineAsyncExCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:462

---

DeleteMessageSelfAsync

▸ DeleteMessageSelfAsync(msg, ext, cb): void

Parameters

Name	Type
msg	IMMessage
ext	string
cb	null | DeleteMessageSelfAsyncCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:470

---

QueryMessageIsThreadRoot

▸ QueryMessageIsThreadRoot(client_id, cb): void

Parameters

Name	Type
client_id	string
cb	null | QueryMessageIsThreadRootCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:472

---

QueryMessageOnline

▸ QueryMessageOnline(param, cb): void

Parameters

Name	Type
param	QueryMsgAsyncParam
cb	null | QueryMessageOnlineCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:474

---

QueryThreadHistoryMsg

▸ QueryThreadHistoryMsg(msg, param, cb): void

Parameters

Name	Type
msg	IMMessage
param	QueryThreadHistoryMsgAsyncParam
cb	null | QueryThreadHistoryMsgCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:476

---

FullTextSearchOnlineAsync

▸ FullTextSearchOnlineAsync(param, cb): void

Parameters

Name	Type
param	FullTextSearchOnlineAsyncParam
cb	null | FullTextSearchOnlineAsyncCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:478