default | im_electron

- Defined in manager/advanceMessageManager.ts:1435
事件回调接口

note

如果用户是登录状态，ImSDK收到新消息会通过此接口设置的回调抛出，另外需要注意，抛出的消息不一定是未读的消息，只是本地曾经没有过的消息（例如在另外一个终端已读，拉取最近联系人消息时可以获取会话最后一条消息，如果本地没有，会通过此方法抛出）。在用户登录之后，ImSDK会拉取离线消息，为了不漏掉消息通知，需要在登录之前注册新消息通知。

Parameters
- params: TIMRecvNewMsgCallbackParams
Returns void

TIMRemoveRecvNewMsgCallback

TIMRemoveRecvNewMsgCallback(): void

- Defined in manager/advanceMessageManager.ts:1457
删除接收新消息回调

note

参数cb需要跟TIMAddRecvNewMsgCallback传入的cb一致，否则删除回调失败

Returns void

TIMSetMsgElemUploadProgressCallback

TIMSetMsgElemUploadProgressCallback(params: TIMMsgElemUploadProgressCallbackParams): void

- Defined in manager/advanceMessageManager.ts:1519
设置消息内元素相关文件上传进度回调

note

设置消息元素上传进度回调。当消息内包含图片、声音、文件、视频元素时，ImSDK会上传这些文件，并触发此接口设置的回调，用户可以根据回调感知上传的进度

Parameters
- params: TIMMsgElemUploadProgressCallbackParams
Returns void

TIMSetMsgReadedReceiptCallback

TIMSetMsgReadedReceiptCallback(params: TIMMsgReadedReceiptCallbackParams): void

- Defined in manager/advanceMessageManager.ts:1470
设置消息已读回执回调

note

发送方发送消息，接收方调用接口TIMMsgReportReaded上报该消息已读，发送方ImSDK会通过此接口设置的回调抛出。

Parameters
- params: TIMMsgReadedReceiptCallbackParams
Returns void

TIMSetMsgRevokeCallback

TIMSetMsgRevokeCallback(params: TIMMsgRevokeCallbackParams): void

- Defined in manager/advanceMessageManager.ts:1495
设置接收的消息被撤回回调

note

发送方发送消息，接收方收到消息。此时发送方调用接口TIMMsgRevoke撤回该消息，接收方的ImSDK会通过此接口设置的回调抛出。

Parameters
- params: TIMMsgRevokeCallbackParams
Returns void

TIMSetMsgUpdateCallback

TIMSetMsgUpdateCallback(params: TIMMsgUpdateCallbackParams): void

- Defined in manager/advanceMessageManager.ts:1556
设置消息在云端被修改后回传回来的消息更新通知回调

note

当您发送的消息在服务端被修改后，ImSDK会通过该回调通知给您您可以在您自己的服务器上拦截所有即时通信IM消息发单聊消息之前回调设置成功之后，即时通信IM服务器会将您的用户发送的每条消息都同步地通知给您的业务服务器。您的业务服务器可以对该条消息进行修改（例如过滤敏感词），如果您的服务器对消息进行了修改，ImSDK就会通过此回调通知您。

Parameters
- params: TIMMsgUpdateCallbackParams
Returns void

下载合并消息

TIMMsgDownloadMergerMessage

TIMMsgDownloadMergerMessage(msgDownloadMergerMessageParams: MsgDownloadMergerMessageParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1223
下载合并消息

Parameters
- msgDownloadMergerMessageParams: MsgDownloadMergerMessageParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

下载消息内元素到指定文件路径

TIMMsgDownloadElemToPath

TIMMsgDownloadElemToPath(msgDownloadElemToPathParams: MsgDownloadElemToPathParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1172
下载消息内元素到指定文件路径(图片、视频、音频、文件)

Parameters
- msgDownloadElemToPathParams: MsgDownloadElemToPathParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

保存自定义消息

TIMMsgSaveMsg

TIMMsgSaveMsg(msgSaveMsgParams: MsgSaveMsgParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:665
保存自定义消息

note

消息保存接口，一般是自己构造一个消息Json字符串，然后保存到指定会话

Parameters
- msgSaveMsgParams: MsgSaveMsgParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_param, user_data }

删除指定会话的本地及漫游消息

TIMMsgListDelete

TIMMsgListDelete(msgListDeleteParams: MsgListDeleteParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:901
删除指定会话的本地及漫游消息

Parameters
- msgListDeleteParams: MsgListDeleteParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

删除指定会话的本地消息

TIMMsgDelete

TIMMsgDelete(msgDeleteParams: MsgDeleteParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:836
删除指定会话的本地消息

note

本接口会在删除本地消息的同时也会删除漫游消息。需要注意以下几点：

建议将之前的消息数组Json保存，然后删除的时候直接调用接口，避免构造消息数组。一次最多只能删除 30 条消息。一秒钟最多只能调用一次该接口。如果该账号在其他设备上拉取过这些消息，那么调用该接口删除后，这些消息仍然会保存在那些设备上，即删除消息不支持多端同步。

Parameters
- msgDeleteParams: MsgDeleteParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

发送消息

TIMMsgSendMessage

TIMMsgSendMessage(msgSendMessageParams: MsgSendMessageParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:97
发送新消息，单聊消息和群消息的发送均采用此接口。

note

注意：

发送新消息，单聊消息和群消息的发送均采用此接口。发送单聊消息时 conv_id 为对方的UserID， conv_type 为 Conv_C2C 发送群聊消息时 conv_id 为群ID， conv_type 为 Conv_Group 。发送消息时不能发送 kTIMElem_GroupTips 、 kTIMElem_GroupReport ，他们由为后台下发，用于更新(通知)群的信息。可以的发送消息内元素文本消息元素，请参考 TextElem 表情消息元素，请参考 FaceElem 位置消息元素，请参考 LocationElem 图片消息元素，请参考 ImageElem 声音消息元素，请参考 SoundElem 自定义消息元素，请参考 CustomElem 文件消息元素，请参考 FileElem 视频消息元素，请参考 VideoElem

Parameters
- msgSendMessageParams: MsgSendMessageParams
Returns Promise<commonResponse>

Promise的response返回值为：{ code, desc, json_params, user_data }

TIMMsgSendMessageV2

TIMMsgSendMessageV2(msgSendMessageParams: MsgSendMessageParamsV2): Promise<unknown>

- Defined in manager/advanceMessageManager.ts:180
发送新消息，单聊消息和群消息的发送均采用此V2接口（返回值与TIMMsgSendMessage不同）

note

与TIMMsgSendMessage不同的是他的返回值不一样并且增加了callback参数

Parameters
- msgSendMessageParams: MsgSendMessageParamsV2
Returns Promise<unknown>

Promise的response返回值为：message_id(消息ID)

取消发送中的消息

TIMMsgCancelSend

TIMMsgCancelSend(msgCancelSendParams: MsgCancelSendParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:261
根据消息 messageID 取消发送中的消息

Parameters
- msgCancelSendParams: MsgCancelSendParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

导入消息列表到指定会话

TIMMsgImportMsgList

TIMMsgImportMsgList(msgImportMsgListParams: MsgImportMsgListParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:609
导入消息列表到指定会话

note

批量导入消息，可以自己构造消息去导入。也可以将之前要导入的消息数组Json保存，然后导入的时候直接调用接口，避免构造消息数组

Parameters
- msgImportMsgListParams: MsgImportMsgListParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_param, user_data }

搜索本地消息

TIMMsgSearchLocalMessages

TIMMsgSearchLocalMessages(msgSearchLocalMessagesParams: MsgSearchLocalMessagesParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1322
搜索本地消息

Parameters
- msgSearchLocalMessagesParams: MsgSearchLocalMessagesParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

查询本地的消息列表

TIMMsgFindMessages

TIMMsgFindMessages(msgFindMessagesParams: MsgFindMessagesParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:315
根据消息 messageID 查询本地的消息列表

Parameters
- msgFindMessagesParams: MsgFindMessagesParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

查询针对某个用户的 C2C 消息接收选项

TIMMsgGetC2CReceiveMessageOpt

TIMMsgGetC2CReceiveMessageOpt(msgGetC2CReceiveMessageOptParams: MsgGetC2CReceiveMessageOptParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1068
查询针对某个用户的 C2C 消息接收选项

Parameters
- msgGetC2CReceiveMessageOptParams: MsgGetC2CReceiveMessageOptParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

根据消息定位精准查找指定会话的消息

TIMMsgFindByMsgLocatorList

TIMMsgFindByMsgLocatorList(msgFindByMsgLocatorListParams: MsgFindByMsgLocatorListParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:552
根据消息定位精准查找指定会话的消息

note

此接口根据消息定位符精准查找指定会话的消息，该功能一般用于消息撤回时查找指定消息等一个消息定位符对应一条消息

Parameters
- msgFindByMsgLocatorListParams: MsgFindByMsgLocatorListParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_param, user_data }

消息上报已读

TIMMsgReportReaded

TIMMsgReportReaded(msgReportReadedParams: MsgReportReadedParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:374
消息上报已读

Parameters
- msgReportReadedParams: MsgReportReadedParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_param, user_data }

消息撤回

TIMMsgRevoke

TIMMsgRevoke(msgRevokeParams: MsgRevokeParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:489
消息撤回

note

消息撤回。使用保存的消息Json或者用消息定位符查找到的消息Json，避免重复构造消息Json.

Parameters
- msgRevokeParams: MsgRevokeParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_param, user_data }

清空指定会话的消息

TIMMsgClearHistoryMessage

TIMMsgClearHistoryMessage(msgClearHistoryMessageParams: MsgClearHistoryMessageParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:961
清空指定会话的消息

Parameters
- msgClearHistoryMessageParams: MsgClearHistoryMessageParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

群发消息

TIMMsgBatchSend

TIMMsgBatchSend(msgBatchSendParams: MsgBatchSendParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1273
群发消息，该接口不支持向群组发送消息。

Parameters
- msgBatchSendParams: MsgBatchSendParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

获取指定会话的消息列表

TIMMsgGetMsgList

TIMMsgGetMsgList(msgGetMsgListParams: MsgGetMsgListParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:717
获取指定会话的消息列表

Parameters
- msgGetMsgListParams: MsgGetMsgListParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data}

设置群消息的接收选项

TIMMsgSetGroupReceiveMessageOpt

TIMMsgSetGroupReceiveMessageOpt(msgSetGroupReceiveMessageOptParams: MsgSetGroupReceiveMessageOptParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1120
设置群消息的接收选项

note

查询群消息的接收选项：您可以在群资料（GroupBaseInfo）中获得这个信息

Parameters
- msgSetGroupReceiveMessageOptParams: MsgSetGroupReceiveMessageOptParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

设置针对某个用户的 C2C 消息接收选项

TIMMsgSetC2CReceiveMessageOpt

TIMMsgSetC2CReceiveMessageOpt(msgSetC2CReceiveMessageOptParams: MsgSetC2CReceiveMessageOptParams): Promise<commonResponse>

- Defined in manager/advanceMessageManager.ts:1016
设置针对某个用户的 C2C 消息接收选项（支持批量设置）

note

该接口支持批量设置，您可以通过参数 userIDList 设置一批用户，但一次最大允许设置 30 个用户。该接口调用频率被限制为1秒内最多调用5次。

Parameters
- msgSetC2CReceiveMessageOptParams: MsgSetC2CReceiveMessageOptParams
Returns Promise<commonResponse>

Promise的response返回值为{ code, desc, json_params, user_data }

Hierarchy

Index

高级消息相关回调(callback)

下载合并消息

下载消息内元素到指定文件路径

保存自定义消息

删除指定会话的本地及漫游消息

删除指定会话的本地消息

发送消息

取消发送中的消息

导入消息列表到指定会话

搜索本地消息

查询本地的消息列表

查询针对某个用户的 C2C 消息接收选项

根据消息定位精准查找指定会话的消息

消息上报已读

消息撤回

清空指定会话的消息

群发消息

获取指定会话的消息列表

设置群消息的接收选项

设置针对某个用户的 C2C 消息接收选项

高级消息相关回调(callback)

TIMAddRecvNewMsgCallback

事件回调接口

Parameters

params: TIMRecvNewMsgCallbackParams

Returns void

TIMRemoveRecvNewMsgCallback

删除接收新消息回调

Returns void

TIMSetMsgElemUploadProgressCallback

设置消息内元素相关文件上传进度回调

Parameters

params: TIMMsgElemUploadProgressCallbackParams

Returns void

TIMSetMsgReadedReceiptCallback

设置消息已读回执回调

Parameters

params: TIMMsgReadedReceiptCallbackParams

Returns void

TIMSetMsgRevokeCallback

设置接收的消息被撤回回调

Parameters

params: TIMMsgRevokeCallbackParams

Returns void

TIMSetMsgUpdateCallback

设置消息在云端被修改后回传回来的消息更新通知回调

Parameters

params: TIMMsgUpdateCallbackParams

Returns void

下载合并消息

TIMMsgDownloadMergerMessage

下载合并消息

Parameters

msgDownloadMergerMessageParams: MsgDownloadMergerMessageParams

Returns Promise<commonResponse>

下载消息内元素到指定文件路径

TIMMsgDownloadElemToPath

下载消息内元素到指定文件路径(图片、视频、音频、文件)

Parameters

msgDownloadElemToPathParams: MsgDownloadElemToPathParams

Returns Promise<commonResponse>

保存自定义消息

TIMMsgSaveMsg

保存自定义消息

Parameters

msgSaveMsgParams: MsgSaveMsgParams

Returns Promise<commonResponse>

删除指定会话的本地及漫游消息

TIMMsgListDelete

删除指定会话的本地及漫游消息

Parameters

msgListDeleteParams: MsgListDeleteParams

Returns Promise<commonResponse>

删除指定会话的本地消息

TIMMsgDelete

删除指定会话的本地消息

Parameters

msgDeleteParams: MsgDeleteParams