ConvDelete
功能介绍
删除会话
在删除好友或退出群组后,如果不需要查看好友或群会话的历史消息,可以选择删除会话。
会话删除默认关闭多端同步,可在即时通信 IM 控制台 开启多端同步。
删除会话,会同时删除终端和服务器的历史消息,且无法恢复。
会话内的消息在本地删除的同时,在服务器也会同步删除。
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conv_id | string | 是 | 会话ID,c2c会话为user_id,群会话为group_id |
conv_type | TIMConvType | 是 | 会话类型 |
callback | NullValueCallback | 是 | 异步回调 |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conv_id | string | 是 | 会话ID,c2c会话为user_id,群会话为group_id |
conv_type | TIMConvType | 是 | 会话类型 |
callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:'' // json_params为空字符串""
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样 |
user_data | string | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
using UnityEngine;
using UnityEngine.UI;
using com.tencent.im.unity.demo.types;
using com.tencent.imsdk.unity;
using com.tencent.imsdk.unity.types;
using com.tencent.imsdk.unity.enums;
using System;
using com.tencent.im.unity.demo.utils;
using EasyUI.Toast;
using System.Collections;
using System.Collections.Generic;
public class ConvDelete : MonoBehaviour
{
public Text Header;
public Dropdown SelectedConv;
public Text Result;
public Button Submit;
public Button Copy;
private List<ConvInfo> ConvList;
void Start()
{
GameObject.Find("SelectConvLabel").GetComponent<Text>().text = Utils.t("SelectConvLabel");
ConvGetConvListSDK();
Header = GameObject.Find("HeaderText").GetComponent<Text>();
SelectedConv = GameObject.Find("Dropdown").GetComponent<Dropdown>();
Result = GameObject.Find("ResultText").GetComponent<Text>();
Submit = GameObject.Find("Submit").GetComponent<Button>();
Copy = GameObject.Find("Copy").GetComponent<Button>();
Copy.GetComponentInChildren<Text>().text = Utils.t("Copy");
Submit.onClick.AddListener(ConvDeleteSDK);
Copy.onClick.AddListener(CopyText);
SelectedConv.interactable = true;
if (CurrentSceneInfo.info != null)
{
Header.text = Utils.IsCn() ? CurrentSceneInfo.info.apiText + " " + CurrentSceneInfo.info.apiName : CurrentSceneInfo.info.apiName;
Submit.GetComponentInChildren<Text>().text = CurrentSceneInfo.info.apiName;
}
}
void GetConvList(params object[] parameters)
{
try
{
ConvList = new List<ConvInfo>();
SelectedConv.ClearOptions();
string text = (string)parameters[1];
List<ConvInfo> List = Utils.FromJson<List<ConvInfo>>(text);
foreach (ConvInfo item in List)
{
print(item.conv_id);
ConvList.Add(item);
Dropdown.OptionData option = new Dropdown.OptionData();
option.text = item.conv_id;
SelectedConv.options.Add(option);
}
SelectedConv.value = 0;
if (List.Count > 0)
{
SelectedConv.captionText.text = List[0].conv_id;
}
else
{
SelectedConv.captionText.text = "";
}
}
catch (Exception ex)
{
Toast.Show(Utils.t("getConvListFailed"));
}
}
void ConvGetConvListSDK()
{
TIMResult res = TencentIMSDK.ConvGetConvList(Utils.addAsyncStringDataToScreen(GetConvList));
print($"ConvGetConvListSDK {res}");
}
void ConvDeleteSDK()
{
if (ConvList.Count < 1)
{
return;
}
print(ConvList[SelectedConv.value].conv_id);
string conv_id = ConvList[SelectedConv.value].conv_id;
TIMConvType conv_type = ConvList[SelectedConv.value].conv_type;
TIMResult res = TencentIMSDK.ConvDelete(conv_id, conv_type, Utils.addAsyncNullDataToScreen(GetResult));
Result.text = Utils.SynchronizeResult(res);
}
void GetResult(params object[] parameters)
{
ConvGetConvListSDK();
Result.text += (string)parameters[0];
}
void CopyText()
{
Utils.Copy(Result.text);
}
void OnApplicationQuit()
{
TencentIMSDK.Uninit();
}
}