TIMMsgImportMsgList
功能介绍
导入消息列表到指定会话
批量导入消息,可以自己构造消息去导入。也可以将之前要导入的消息数组Json保存,然后导入的时候直接调用接口,避免构造消息数组
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
msgImportMsgListParams | MsgImportMsgListParams | 是 | 导入消息的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | string | undefined | 根据具具体接口返回 |
json_params | string | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { MsgImportMsgListParams,userProfileCustom,GroupMemberInfoCustemString,GroupMemberInfo,userProfile,Json_value_msg } from "im_electron_sdk/dist/interfaces";
let userProfileCustom:userProfileCustom = {
user_profile_custom_string_info_key: '',
user_profile_custom_string_info_value: 'string;'
}
let groupMemberCustom : GroupMemberInfoCustemString = {
group_member_info_custom_string_info_key: '',
group_member_info_custom_string_info_value: '',
}
let groupMemberInfo:GroupMemberInfo ={
group_member_info_identifier: '',
group_member_info_join_time: 0,
group_member_info_member_role: 0,
group_member_info_msg_flag: 0,
group_member_info_msg_seq: 0,
group_member_info_shutup_time: 0,
group_member_info_name_card: '',
group_member_info_custom_info: [groupMemberCustom]
}
let senderProfile:userProfile = {
user_profile_add_permission: 0,
user_profile_birthday:0,
user_profile_custom_string_array: [userProfileCustom],
user_profile_face_url: '',
user_profile_gender: 0,
user_profile_identifier:'',
user_profile_language: 0,
user_profile_level: 0,
user_profile_location: '',
user_profile_nick_name: '',
user_profile_role: 0,
user_profile_self_signature: '',
}
let params:Json_value_msg = {
message_elem_array: [{
elem_type: 1,
text_elem_content:'',
}],
message_conv_id: '',
message_conv_type: 0,
message_sender: '',
message_priority: 0,
message_client_time: 0,
message_server_time: 0,
message_is_from_self: false,
message_platform: 0,
message_is_read: false,
message_is_online_msg:false,
message_status: 0,
message_custom_int: 0,
message_custom_str: '',
message_is_excluded_from_unread_count: false,
message_group_at_user_array: [''],
message_is_forward_message: false,
message_sender_profile: senderProfile,
message_sender_group_member_info: groupMemberInfo,
message_offline_push_config: {}
}
let convId = ''
let convType=0
let param:MsgImportMsgListParams = {
conv_id: convId,
conv_type: convType,
params: [params],
user_data: ''
}
const {code} = await timRenderInstance.TIMMsgImportMsgList(param);
if(code == 0){
// 成功
}