ConvDelete
introduction
Delete conversation
After deleting friend or quitting group, if no need to check history message, you may delete the conversation.
Conversation deletion is not multi-device synchronized by default, you may enable synchronization on IM Console.
Delete conversation will erase history message locally and cloudily and non-recoverable.
Parameter details
overload1
Parameter name | Parameter type | Required | Description |
---|---|---|---|
conv_id | string | Required | Conversation ID, C2C conv: user_id, Group conv: group_id |
conv_type | TIMConvType | Required | Conversation type |
callback | NullValueCallback | Required | Asynchronous callback |
overload2
Parameter name | Parameter type | Required | Description |
---|---|---|---|
conv_id | string | Required | Conversation ID, C2C conv: user_id, Group conv: group_id |
conv_type | TIMConvType | Required | Conversation type |
callback | ValueCallback< string > | Required | Asynchronous callback The format of json_param in the return value is string |
Returned template
TIMResult
The parameters of the callback function after successfully calling the API:
code:int
desc:string
json_param:'' // json_ Params is an empty string ""
user_data:string
Return value details
name | type | description |
---|---|---|
TIMResult | TIMResult | Return value of calling API |
code | int | Result error code: Error Codes |
desc | string | The description of the error. |
json_param | string | Json string. Calling different API will get different Json strings. |
user_data | string | User-defined data transfered by ImSDK without any processing |
Code example
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();
}
}