[**RongIMLib**](../README.md)

***

[RongIMLib](../globals.md) / clearMessagesUnreadStatus

# Variable: clearMessagesUnreadStatus

> `const` **clearMessagesUnreadStatus**: [`MonitorableAPI`](../type-aliases/MonitorableAPI.md)\<(`options`) => `Promise`\<[`RCResult`](../interfaces/RCResult.md)\<`void`\>\>\>

清除指定会话未读数

## Description

清除指定会话的未读数（不含聊天室会话类型）
**注意**：
1. Web 端会话未读数保存在 localstorage 中，如清除浏览器缓存会导致会话未读数不准确
2. 聊天室会话类型不存储未读数，故不支持清除聊天室会话的未读数
3. 未读数为本地为本地存储，清除后不可恢复，如用户多端未读数不会主动做多端同步，如需要多端同步需要通过 [sendSyncReadStatusMessage](../functions/sendSyncReadStatusMessage.md) 接口进行同步

## Param

**options**

会话信息

## Example

清除指定会话未读数示例：
```ts
const options = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId',
}
const clearRes = await RongIMLib.clearMessagesUnreadStatus(options);
console.info('清除指定会话未读数结果：', clearRes);
```