会话草稿
保存草稿
- 保存一条草稿内容至指定会话。
- 保存草稿会更新会话的
sentTime
,该会话会排在列表前部。
方法
saveDraftMessage(type: RCIMIWConversationType, targetId: string, channelId: string, draft: string): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,暂不支持该参数。传 null 即可。 |
draft | string | 草稿的文字内容 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.saveDraftMessage(
type,
useTargetId,
useChannelId,
useDraft
)
.then((code: number) => {});
回调方法
- setOnDraftMessageSavedListener
setOnDraftMessageSavedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, draft: string) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 调用接口时传入的会话类型 |
targetId | string | 调用接口时传入的会话ID |
channelId | string | 调用接口时传入的频道 ID |
draft | string | 保存的草稿 |
代码示例
engine.setOnDraftMessageSavedListener(
(
code: number,
type: RCIMIWConversationType,
targetId: string,
channelId: string,
draft: string
) => {}
);
获取草稿
获取草稿内容。
方法
loadDraftMessage(type: RCIMIWConversationType, targetId: string, channelId: string): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
conversationType | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,暂不支持该参数。传 null 即可。 |
返回值
参数 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.loadDraftMessage(
type,
targetId,
channelId
)
.then((code: number) => {});
回调方法
- setOnDraftMessageLoadedListener
setOnDraftMessageLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, draft: string) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 调用接口时传入的会话类型 |
targetId | string | 调用接口时传入的会话ID |
channelId | string | 调用接口时传入的频道 ID |
draft | string | 获取的草稿 |
代码示例
engine.setOnDraftMessageLoadedListener(
(
code: number,
type: RCIMIWConversationType,
targetId: string,
channelId: string,
draft: string
) => {}
);
删除草稿
清除某个会话的草稿信息。
方法
clearDraftMessage(type: RCIMIWConversationType, targetId: string, channelId: string): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
conversationType | RCIMIWConversationType | 会话类型 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,暂不支持该参数。传 null 即可。 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.clearDraftMessage(
type,
targetId,
channelId
)
.then((code: number) => {});
回调方法
- setOnDraftMessageClearedListener
setOnDraftMessageClearedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
type | RCIMIWConversationType | 调用接口时传入的会话类型 |
targetId | string | 调用接口时传入的会话ID |
channelId | string | 调用接口时传入的频道 ID |
代码示例
engine.setOnDraftMessageClearedListener(
(
code: number,
type: RCIMIWConversationType,
targetId: string,
channelId: string
) => {}
);