MsgDelete
功能介绍
消息删除
删除消息分为两种:删除本地消息和删除云端消息。
删除云端消息会在删除本地消息的基础上,同步删除云端存储的消息,且无法恢复。
如果删除的是最后一条消息,会话的 lastMessage 会变为前一条消息。
删除本地消息:
删除本地历史后,SDK 会在本地把这条消息标记为已删除状态,调用 MsgGetMsgList 不能再拉取到。
如果程序卸载重装,本地会失去对这条消息的删除标记,调用 MsgGetMsgList 还能再拉取到该条消息。
删除云端存储的消息:
该接口会在删除本地消息的基础上,同步删除云端存储的消息,且无法恢复。
每次调用,最多只能删除 30 条消息。
每次调用,待删除的消息必须属于同一会话。
1 秒钟最多只能调用 1 次该接口。
如果一个账号在某设备上拉取过这些消息,那么调用该接口删除云端消息后,这些消息仍然会保存在该设备上,即删除消息不支持多端同步。
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conv_id | string | 是 | 会话ID |
conv_type | TIMConvType | 是 | 会话类型 |
message_delete_param | MsgDeleteParam | 是 | 删除消息参数 |
callback | NullValueCallback | 是 | 异步回调 |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conv_id | string | 是 | 会话ID |
conv_type | TIMConvType | 是 | 会话类型 |
message_delete_param | MsgDeleteParam | 是 | 删除消息参数 |
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 MsgDelete : MonoBehaviour
{
public Text Header;
public Dropdown SelectedConv;
public Dropdown SelectedMsg;
public Text Result;
public Button Submit;
public Button Copy;
public Toggle PinToggle;
private List<ConvInfo> ConvList;
private List<Message> MsgList;
void Start()
{
GameObject.Find("SelectConvLabel").GetComponent<Text>().text = Utils.t("SelectConvLabel");
GameObject.Find("SelectMsgLabel").GetComponent<Text>().text = Utils.t("SelectMsgLabel");
ConvGetConvListSDK();
Header = GameObject.Find("HeaderText").GetComponent<Text>();
SelectedConv = GameObject.Find("Dropdown").GetComponent<Dropdown>();
SelectedMsg = GameObject.Find("MsgDropdown").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(MsgDeleteSDK);
Copy.onClick.AddListener(CopyText);
SelectedConv.interactable = true;
SelectedConv.onValueChanged.AddListener(delegate
{
GroupDropdownValueChanged(SelectedConv);
});
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 GroupDropdownValueChanged(Dropdown change)
{
SelectedMsg.captionText.text = "";
SelectedMsg.ClearOptions();
SelectedMsg.value = 0;
MsgList = new List<Message>();
if (ConvList.Count > 0)
{
string conv_id = ConvList[change.value].conv_id;
TIMConvType conv_type = ConvList[change.value].conv_type;
MsgGetMsgListSDK(conv_id, conv_type);
}
}
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);
}
if (List.Count > 0)
{
SelectedConv.captionText.text = List[SelectedConv.value].conv_id;
GroupDropdownValueChanged(SelectedConv);
}
}
catch (Exception ex)
{
Toast.Show(Utils.t("getConvListFailed"));
}
}
void GetMsgList(params object[] parameters)
{
try
{
string text = (string)parameters[1];
List<Message> ListRes = Utils.FromJson<List<Message>>(text);
foreach (Message item in ListRes)
{
print(item.message_msg_id);
MsgList.Add(item);
Dropdown.OptionData option = new Dropdown.OptionData();
option.text = item.message_msg_id;
SelectedMsg.options.Add(option);
}
if (ListRes.Count > 0)
{
SelectedMsg.captionText.text = ListRes[SelectedMsg.value].message_msg_id;
}
}
catch (Exception ex)
{
Toast.Show(Utils.t("getMsgListFailed"));
}
}
void ConvGetConvListSDK()
{
TIMResult res = TencentIMSDK.ConvGetConvList(Utils.addAsyncStringDataToScreen(GetConvList));
print($"ConvGetConvListSDK {res}");
}
void MsgGetMsgListSDK(string conv_id, TIMConvType conv_type)
{
var get_message_list_param = new MsgGetMsgListParam
{
msg_getmsglist_param_count = 20
};
print(conv_id + conv_type);
TIMResult res = TencentIMSDK.MsgGetMsgList(conv_id, conv_type, get_message_list_param, Utils.addAsyncStringDataToScreen(GetMsgList));
}
void MsgDeleteSDK()
{
if (ConvList.Count < 1 || MsgList.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;
MsgDeleteParam param = new MsgDeleteParam { msg_delete_param_msg = MsgList[SelectedMsg.value] };
TIMResult res = TencentIMSDK.MsgDelete(conv_id, conv_type, param, Utils.addAsyncNullDataToScreen(GetResult));
Result.text = Utils.SynchronizeResult(res);
}
void GetResult(params object[] parameters)
{
GroupDropdownValueChanged(SelectedConv);
Result.text += (string)parameters[0];
}
void CopyText()
{
Utils.Copy(Result.text);
}
void OnApplicationQuit()
{
TencentIMSDK.Uninit();
}
}