草稿

按会话保存文本草稿，支持跨页面恢复与清除；草稿仅保存在本地。

平台调用风格

双语言同契约：Swift 用 async -> RcResult<T>（错误码在 RcResult.code，返回 null 的 op 用 RcResult<Void>）；Objective-C 用 - (void)opWithParam:... completion:(void (^)(RcResult *))completion，回调在主线程投递。

接口一览​

操作语义传输返回
saveTextMessageDraft保存草稿（空串=清除）。REST（客户端）null
getTextMessageDraft读取草稿；无草稿返回空串。REST（客户端）string
clearTextMessageDraft清除草稿。REST（客户端）null

本页 3 个操作，其中 3 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
saveTextMessageDraftsaveTextMessageDraftsaveTextMessageDraftsaveTextMessageDraftsaveTextMessageDraftsaveTextMessageDraft—func
getTextMessageDraftgetTextMessageDraftgetTextMessageDraftgetTextMessageDraftgetTextMessageDraftgetTextMessageDraft—func
clearTextMessageDraftclearTextMessageDraftclearTextMessageDraftclearTextMessageDraftclearTextMessageDraftclearTextMessageDraft—func

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

saveTextMessageDraft​

保存草稿（空串=清除）。

func saveTextMessageDraft(conversationType: IMPConversationType, targetId: String, draft: String) async -> RcResult<Void>
REST（客户端）幂等since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填；会话类型枚举（ConversationType）
targetIdstring必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
draftstring必填；草稿文本，空串表示清除
返回

null 无返回数据；成功与否通过错误码判断

示例（Swift / Objective-C）​

let res = await client.saveTextMessageDraft(conversationType: .privateChat, targetId: "user2", draft: "明天见")
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client saveTextMessageDraftWithConversationType:1 /* 单聊 */ targetId:@"user2" draft:@"明天见" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

getTextMessageDraft​

读取草稿；无草稿返回空串。

func getTextMessageDraft(conversationType: IMPConversationType, targetId: String) async -> RcResult<String>
REST（客户端）since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填；会话类型枚举（ConversationType）
targetIdstring必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
返回

string 字符串

示例（Swift / Objective-C）​

let res = await client.getTextMessageDraft(conversationType: .privateChat, targetId: "user2")
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client getTextMessageDraftWithConversationType:1 /* 单聊 */ targetId:@"user2" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

clearTextMessageDraft​

清除草稿。

func clearTextMessageDraft(conversationType: IMPConversationType, targetId: String) async -> RcResult<Void>
REST（客户端）幂等since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填；会话类型枚举（ConversationType）
targetIdstring必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
返回

null 无返回数据；成功与否通过错误码判断

示例（Swift / Objective-C）​

let res = await client.clearTextMessageDraft(conversationType: .privateChat, targetId: "user2")
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client clearTextMessageDraftWithConversationType:1 /* 单聊 */ targetId:@"user2" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​