Skip to content

nim_def.msglog_def.NIMMsgLogAPI

Jump to bottom
Zvicii edited this page Apr 19, 2023 · 6 revisions

Interface: NIMMsgLogAPI

nim_def/msglog_def.NIMMsgLogAPI

Table of contents

Methods

Methods

InitEventHandlers

▸ InitEventHandlers(): void

Returns

void

Defined in

ts/nim_def/msglog_def.ts:374

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:376

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:378

GetMessagesDynamically

▸ GetMessagesDynamically(session_id, to_type, from_time, to_time, limit_count, anchor_client_msg_id, anchor_server_msg_id, direction, cb, jsonExtension): void

Parameters

Name Type
session_id string
to_type NIMSessionType
from_time number
to_time number
limit_count number
anchor_client_msg_id string
anchor_server_msg_id number
direction NIMMsglogSearchDirection
cb null | GetMessagesDynamicallyCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/msglog_def.ts:387

QueryMsgOnlineAsync

▸ QueryMsgOnlineAsync(param, cb): boolean

Parameters

Name Type
param QueryMsgOnlineAsyncParam
cb null | QueryMsgCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:400

QueryMsgByKeywordOnlineAsync

▸ QueryMsgByKeywordOnlineAsync(param, cb): boolean

Parameters

Name Type
param QueryMsgByKeywordOnlineParam
cb null | QueryMsgCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:402

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:404

QueryMsgByOptionsAsync

▸ QueryMsgByOptionsAsync(param, cb): boolean

Parameters

Name Type
param QueryMsgByOptionsAsyncParam
cb null | QueryMsgCallback

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:417

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:419

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:421

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:429

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:431

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:433

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:442

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:450

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:452

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:454

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:464

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:466

SendReceiptAsync

▸ SendReceiptAsync(msg, cb): void

Parameters

Name Type
msg IMMessage
cb null | MessageStatusChangedCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:468

QuerySentMessageBeReaded

▸ QuerySentMessageBeReaded(msg): boolean

Parameters

Name Type
msg IMMessage

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:470

QueryReceivedMsgReceiptSent

▸ QueryReceivedMsgReceiptSent(msg): boolean

Parameters

Name Type
msg IMMessage

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:472

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:474

ReadAllAsync

▸ ReadAllAsync(cb, jsonExtension): boolean

Parameters

Name Type
cb null | DBFunctionCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:476

ExportBackupToRemote

▸ ExportBackupToRemote(export_info): boolean

Parameters

Name Type
export_info LogsBackupExportInfo

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:478

ImportBackupToRemote

▸ ImportBackupToRemote(export_info): boolean

Parameters

Name Type
export_info LogsBackupImportInfo

Returns

boolean

Defined in

ts/nim_def/msglog_def.ts:480

CancelImportBackupFromRemote

▸ CancelImportBackupFromRemote(): void

Returns

void

Defined in

ts/nim_def/msglog_def.ts:482

CancelExportBackupToRemote

▸ CancelExportBackupToRemote(): void

Returns

void

Defined in

ts/nim_def/msglog_def.ts:484

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:486

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:488

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:496

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:498

QueryMessageOnline

▸ QueryMessageOnline(param, cb): void

Parameters

Name Type
param QueryMsgAsyncParam
cb null | QueryMessageOnlineCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:500

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:502

FullTextSearchOnlineAsync

▸ FullTextSearchOnlineAsync(param, cb): void

Parameters

Name Type
param FullTextSearchOnlineAsyncParam
cb null | FullTextSearchOnlineAsyncCallback

Returns

void

Defined in

ts/nim_def/msglog_def.ts:504

node-nim

Modules

Clone this wiki locally