TIMFriendshipModifyFriendProfile
功能介绍
更新好友资料(备注等)
修改好友资料,目前支持修改的字段请参考FriendProfileItem(在interface里),一次可修改多个字段。修改自定义字段时填入的key值可以添加 TagSNS_Custom 前缀,也可以不添加 TagSNS_Custom 前缀,当不添加时,SDK内部会自动添加该前缀。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
modifyFriendProfileParams | ModifyFriendProfileParams | 是 | 更新好友资料(备注等)的参数 |
返回模板
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 { ModifyFriendProfileParams,FriendProfileItem,FriendProfileCustemStringInfo } from "im_electron_sdk/dist/interfaces";
let customString:FriendProfileCustemStringInfo = {
user_data:'', //选填
friend_profile_custom_string_info_key: '', //必填
friend_profile_custom_string_info_value:'' //必填
}
let friendProfileItem:FriendProfileItem = {
friend_profile_item_remark: "", //选填
friend_profile_item_group_name_array: [""], //选填
friend_profile_item_custom_string_array:[customString] //选填
}
let param : ModifyFriendProfileParams = {
params: {
friendship_modify_friend_profile_param_identifier: "", //选填
friendship_modify_friend_profile_param_item: friendProfileItem //选填
},
user_data: "1234" //选填
}
const {code} = await timRenderInstance.TIMFriendshipModifyFriendProfile(param);
if(code == 0){
// 成功
}