ConvGetConvList
功能介绍
获取会话列表
用户的会话以列表的形式返回,列表中存储的是 ConvInfo 对象。目前 IM SDK 对会话列表的排序规则为:
该接口拉取的是本地缓存的会话,如果服务器会话有更新,SDK 内部会自动同步,然后在 ConvEventCallback 回调告知客户。
本地存储的会话列表没有数量上限。
云端存储的会话列表最大数量为 100。如果您希望扩展此数量,可以升级旗舰版。旗舰版用户可以在控制台配置最高数量为 500,配置页面如下图所示:
长时间没有信息变更,该会话在云端最多保存 7 天。如需放宽限制,请 联系我们。
本地存储的会话和云端存储的会话并不总是一致的,如果用户不主动调用 ConvDelete 接口删除本地的会话,该会话就会一直存在。而云端存储的会话最大只会保存 100 条,且对于长时间没有信息变更的会话,云端最多保存 7 天,所以不同的终端本地显示的会话可能会不一样。
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callback | ValueCallback< List< ConvInfo > > | 是 | 异步回调 返回值的json_param的格式为json |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:
'[
{
"conv_active_time" : 1551269275,
"conv_id" : "user2",
"conv_is_has_draft" : false,
"conv_is_has_lastmsg" : true,
"conv_last_msg" : {
"message_client_time" : 1551235066,
"message_conv_id" : "user2",
"message_conv_type" : 1,
"message_elem_array" : [
{
"elem_type" : 0,
"text_elem_content" : "ccccccccccccccccc"
}
],
"message_is_from_self" : true,
"message_is_read" : true,
"message_rand" : 1073033786,
"message_sender" : "user1",
"message_seq" : 16373,
"message_server_time" : 1551235067,
"message_status" : 2
},
"conv_owner" : "",
"conv_type" : 1,
"conv_unread_num" : 0
}
]'// Json Key请参考ConvInfo
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样,Json Key请参考ConvInfo |
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 com.tencent.im.unity.demo.utils;
using System.Linq;
using System.Collections;
using System.Collections.Generic;
public class ConvGetConvList : MonoBehaviour
{
public Text Header;
public Text Result;
public Button Submit;
public Button Copy;
public List<string> ResultText;
private string Data;
void Start()
{
Result = GameObject.Find("ResultText").GetComponent<Text>();
Header = GameObject.Find("HeaderText").GetComponent<Text>();
Submit = GameObject.Find("Submit").GetComponent<Button>();
if (CurrentSceneInfo.info != null)
{
Header.text = Utils.IsCn() ? CurrentSceneInfo.info.apiText + " " + CurrentSceneInfo.info.apiName : CurrentSceneInfo.info.apiName;
Submit.GetComponentInChildren<Text>().text = CurrentSceneInfo.info.apiName;
}
Copy = GameObject.Find("Copy").GetComponent<Button>();
Copy.GetComponentInChildren<Text>().text = Utils.t("Copy");
Submit.onClick.AddListener(ConvGetConvListSDK);
Copy.onClick.AddListener(CopyText);
}
void ConvGetConvListSDK()
{
var Parent = GameObject.Find("ResultPanel");
foreach (Transform child in Parent.transform)
{
GameObject.Destroy(child.gameObject);
}
Result = Instantiate(Result, Parent.transform);
Result.enabled = true;
TIMResult res = TencentIMSDK.ConvGetConvList(Utils.addAsyncStringDataToScreen(GetResult));
Result.text = Utils.SynchronizeResult(res);
}
void GenerateResultText()
{
var Parent = GameObject.Find("ResultPanel");
foreach (string resultText in ResultText)
{
var obj = Instantiate(Result, Parent.transform);
obj.text = resultText;
}
}
void GetResult(params object[] parameters)
{
ResultText = new List<string>();
// ArgumentException: Mesh can not have more than 65000 vertices
// Deal with a single Text cannot render too many words issue
string CallbackData = (string)parameters[0];
string[] DataList = CallbackData.Split('\n');
int count = 0;
while (count < DataList.Length)
{
// Every 400 lines render a new Text
int end = count + 400;
if (end > DataList.Length)
{
end = DataList.Length;
}
string[] textList = DataList.Skip(count).Take(end - count).ToArray();
ResultText.Add(string.Join("\n", textList));
count = end;
}
Data = (string)parameters[0];
GenerateResultText();
}
void CopyText()
{
Utils.Copy(Data);
}
void OnApplicationQuit()
{
TencentIMSDK.Uninit();
}
}