会话草稿
保存草稿
- 保存一条草稿内容至指定会话。
- 保存草稿会更新会话的
sentTime
,该会话会排在列表前部。
方法
saveDraftMessage(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
draft: string,
callback: IRCIMIWSaveDraftMessageCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
draft | string | 草稿的文字内容。 |
callback | IRCIMIWSaveDraftMessageCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。 |
代码示例
let callback = {
onDraftMessageSaved:(res) => {
//...
}};
let code = await engine.saveDraftMessage(type, targetId, channelId, draft, callback);
回调方法
- setOnDraftMessageSavedListener
setOnDraftMessageSavedListener(listener?: ({code, type, targetId, channelId, draft}) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
draft | string | 草稿信息 |
代码示例
engine.setOnDraftMessageSavedListener((res) => {
//...
});
获取草稿
获取草稿内容。
方法
getDraftMessage(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
callback: IRCIMIWGetDraftMessageCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
callback | IRCIMIWGetDraftMessageCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。 |
代码示例
let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getDraftMessage(type, targetId, channelId, callback);
回调方法
- setOnDraftMessageLoadedListener
setOnDraftMessageLoadedListener(listener?: ({code, type, targetId, channelId, draft}) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | number | 接口回调的状态码,0 代 表成功,非 0 代表出现异常 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
draft | string | 草稿信息 |
代码示例
engine.setOnDraftMessageLoadedListener((res) => {
//...
});
删除草稿
清除某个会话的草稿信息。
方法
clearDraftMessage(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
callback: IRCIMIWClearDraftMessageCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
callback | IRCIMIWClearDraftMessageCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。 |
代码示例
clearDraftMessage(
type: RCIMIWConversationType,
targetId: string,
channelId: string,
callback: IRCIMIWClearDraftMessageCallback
): Promise<number>;
回调方法
- setOnDraftMessageClearedListener
setOnDraftMessageClearedListener(listener?: ({code, type, targetId, channelId}) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
代码示例
engine.setOnDraftMessageClearedListener((res) => {
//...
});