会话未读数

获取所有会话未读数

获取所有会话类型(除聊天室外)的未读数。

方法

loadTotalUnreadCount(channelId: string): Promise<number>;

参数说明

参数	类型	说明
channelId	string	频道 ID，暂不支持该参数。传 null 即可。

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

engine.loadTotalUnreadCount(channelId);
.then((code: number) => {});

回调方法

• setOnTotalUnreadCountLoadedListener

setOnTotalUnreadCountLoadedListener(listener?: (code: number, channelId: string, count: number) => void): void;

参数说明

参数	类型	说明
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
channelId	string	调用接口时传入的频道 ID
count	number	未读消息数

代码示例

engine.setOnTotalUnreadCountLoadedListener(
  (
    code: number,
    channelId: string,
    count: number
  ) => {}
);

获取指定会话未读数

获取指定会话(除聊天室外)的所有未读消息个数。

方法

loadUnreadCount(type: RCIMIWConversationType, targetId: string, channelId: string): Promise<number>;

参数说明

参数	类型	说明
conversationType	RCIMIWConversationType	会话类型(除聊天室外)
targetId	string	会话 Id
channelId	string	频道 ID，暂不支持该参数。传 null 即可。

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

engine.loadUnreadCount(
  type,
  targetId,
  channelId
)
.then((code: number) => {});

回调方法

• setOnUnreadCountLoadedListener

setOnUnreadCountLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void): void;

参数说明

参数	类型	说明
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
type	RCIMIWConversationType	调用接口时传入的会话类型
targetId	string	调用接口时传入的会话 Id
channelId	string	调用接口时传入的频道 ID
count	number	未读消息数

代码示例

engine.setOnUnreadCountLoadedListener(
  (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    count: number
  ) => {}
);

按会话类型获取未读数

获取多个指定会话类型(除聊天室外)的未读数。

方法

loadUnreadCountByConversationTypes(conversationTypes: Array<RCIMIWConversationType>, channelId: string, contain: boolean): Promise<number>;

参数说明

参数	类型	说明
conversationTypes	Array<RCIMIWConversationType>	RCIMIWConversationType 会话类型数组。(除聊天室外)
channelId	string	频道 ID，暂不支持该参数。传 null 即可。
contain	boolean	是否包含免打扰消息的未读消息数。

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

let conversationTypes = [RCIMIWConversationType.PRIVATE,RCIMIWConversationType.GROUP];
let channelId = '';
let contain = true ;
engine.loadUnreadCountByConversationTypes(
  conversationTypes,
  channelId,
  contain
)
.then((code: number) => {});

回调方法

• setOnUnreadCountByConversationTypesLoadedListener

setOnUnreadCountByConversationTypesLoadedListener(listener?: (code: number, types: Array<RCIMIWConversationType>, channelId: string, contain: boolean, count: number) => void): void;

参数说明

参数	类型	说明
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
types	Array<[RCIMIWConversationType](https://www.rongcloud.cn/docs/api/react-native/imlib_v5/latest/enums/RCIMDefines.RCIMIWConversationType.html)>	调用接口时传入的会话类型列表
channelId	string	调用接口时传入的频道 ID
contain	boolean	是否包含免打扰消息的未读消息数
count	number	未读消息数

代码示例

engine.setOnUnreadCountByConversationTypesLoadedListener(
  (
    code: number,
    types: Array<RCIMIWConversationType>,
    channelId: string,
    contain: boolean,
    count: number
  ) => {}
);

清除指定会话未读数

清除指定会话(除聊天室外)的未读数。

方法

clearUnreadCount(type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number): Promise<number>;

参数说明

参数	类型	说明
type	RCIMIWConversationType	会话类型 (除聊天室外)
targetId	string	会话 ID
channelId	string	频道 ID，暂不支持该参数。传 null 即可。
timestamp	number	该会话已阅读的最后一条消息的发送时间戳

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

engine.clearUnreadCount(
  type,
  targetId,
  channelId,
  timestamp
)
.then((code: number) => {});

回调方法

• setOnUnreadCountClearedListener

setOnUnreadCountClearedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number) => void): void;

参数说明

参数	类型	说明
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
type	RCIMIWConversationType	调用接口时传入的会话类型
targetId	string	调用接口时传入的会话 ID
channelId	string	调用接口时传入的频道 ID
timestamp	number	该会话已阅读的最后一条消息的发送时间戳

代码示例

engine.setOnUnreadCountClearedListener(
  (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    timestamp: number
  ) => {}
);

加载所有@未读数

加载某个会话的所有@未读数

方法

loadUnreadMentionedCount(type: RCIMIWConversationType, targetId: string, channelId: string): Promise<number>;

参数说明

参数	类型	说明
type	RCIMIWConversationType	会话类型
targetId	string	会话 ID
channelId	string	频道 ID，暂不支持该参数。传 null 即可。

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

engine.loadUnreadMentionedCount(
  type,
  targetId,
  channelId
)
.then((code: number) => {});

回调方法

• setOnUnreadMentionedCountLoadedListener

setOnUnreadMentionedCountLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void): void;

参数说明

参数	类型	说明
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
type	RCIMIWConversationType	调用接口时传入的会话类型
targetId	string	调用接口时传入的会话 ID
channelId	string	调用接口时传入的频道 ID
count	number	未读消息数

代码示例

engine.setOnUnreadMentionedCountLoadedListener(
  (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    count: number
  ) => {}
);