跳到主要内容

会话顶置

SDK 提供设置会话是否置顶接口,置顶的状态将会被同步到服务端,切换设备后置顶状态也会一并同步下来。

设置会话置顶

方法

changeConversationTopStatus(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
top: boolean,
callback: IRCIMIWChangeConversationTopStatusCallback
): Promise<number>;

参数说明

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
topboolean是否置顶
callbackIRCIMIWChangeConversationTopStatusCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。

代码示例

let callback = {
onConversationTopStatusChanged:(res) => {
//...
}};
let code = await engine.changeConversationTopStatus(type, targetId, channelId, top, callback);

回调方法

  • setOnConversationTopStatusChangedListener
setOnConversationTopStatusChangedListener(listener?: ({code, type, targetId, channelId, top}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
topboolean是否置顶

代码示例

engine.setOnConversationTopStatusChangedListener((res) => {
//...
});

获取会话置顶状态

通过此方法获取指定会话的置顶状态。

方法

getConversationTopStatus(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
callback: IRCIMIWGetConversationTopStatusCallback
): Promise<number>;

参数说明

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
callbackIRCIMIWGetConversationTopStatusCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。

代码示例

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getConversationTopStatus(type, targetId, channelId, callback);

回调方法

  • setOnConversationTopStatusLoadedListener
setOnConversationTopStatusLoadedListener(listener?: ({code, type, targetId, channelId, top}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
topboolean是否置顶

代码示例

engine.setOnConversationTopStatusLoadedListener((res) => {
//...
});

获取置顶会话列表

获取置顶会话列表

方法

getTopConversations(
conversationTypes: Array<RCIMIWConversationType>,
channelId: string,
callback: IRCIMIWGetTopConversationsCallback
): Promise<number>;

参数说明

参数名参数类型描述
conversationTypesArray<RCIMIWConversationType>会话类型集合
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
callbackIRCIMIWGetTopConversationsCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。

代码示例

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getTopConversations(conversationTypes, channelId, callback);

回调方法

  • setOnTopConversationsLoadedListener
setOnTopConversationsLoadedListener(listener?: ({code, conversationTypes, channelId, conversations}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
conversationTypesArray<RCIMIWConversationType>会话类型集合
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
conversationsArray<RCIMIWConversation>加载的会话集合

代码示例

engine.setOnTopConversationsLoadedListener((res) => {
//...
});

置顶状态同步

SDK 提供了会话状态(置顶或免打扰)同步机制,通过设置会话状态同步监听器,当在其它端修改会话状态时,可在本端实时监听到会话状态的改变。

方法

setOnConversationTopStatusSyncedListener(listener?: ({type, targetId, channelId, top}) => void): void;

参数说明

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
topboolean是否置顶

代码示例

engine.setOnConversationTopStatusSyncedListener((res) => {
//...
});