ConvPinConversation
功能介绍
会话置顶
会话置顶，指的是把好友或者群会话固定在会话列表的最前面，方便用户查找。置顶状态会存储在服务器，切换终端设备后，置顶状态会同步到新设备上。
如果您事先调用了 SetConvEventCallback 添加会话监听器，就可以在 ConvEventCallback 中获取到 ConvInfo 对象的 conv_is_pinned 字段值。根据这个字段可以判断会话的置顶状态是否变化。
调用 ConvGetConvList 获取会话列表时，该接口会先返回置顶的会话，再返回未置顶的会话。您可以通过 ConvInfo 对象的 conv_is_pinned 字段，检查会话有没有置顶。
需要注意的是，被置顶会话始终排在非置顶会话的前面，如果同时置顶多个会话，这几个会话之间的相对顺序仍然会保持，例如，有 5 个依次排序的会话 1、2、3、4、5，同时置顶会话 2 和 3，置顶后的顺序是 2、3、1、4、5，显然，会话 2 和 3 排在最前面，并且会话 2 仍然排在 3 的前面。
置顶会话的顺序，按ConvInfo 对象的 conv_active_time 字段排序。
参数详解
重载1
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| conv_id | string | 是 | 会话ID，c2c会话为user_id，群会话为group_id |
| conv_type | TIMConvType | 是 | 会话类型 |
| is_pinned | bool | 是 | 是否置顶标记 |
| callback | NullValueCallback | 是 | 异步回调 |
重载2
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| conv_id | string | 是 | 会话ID，c2c会话为user_id，群会话为group_id |
| conv_type | TIMConvType | 是 | 会话类型 |
| is_pinned | bool | 是 | 是否置顶标记 |
| 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 ConvPinConversation : MonoBehaviour
{
public Text Header;
public Dropdown SelectedConv;
public Text Result;
public Button Submit;
public Button Copy;
public Toggle PinToggle;
private List<ConvInfo> ConvList;
void Start()
{
GameObject.Find("SelectConvLabel").GetComponent<Text>().text = Utils.t("SelectConvLabel");
GameObject.Find("PinLabel").GetComponent<Text>().text = Utils.t("PinLabel");
ConvGetConvListSDK();
PinToggle = GameObject.Find("Toggle").GetComponent<Toggle>();
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(ConvPinConversationSDK);
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);
}
if (List.Count > 0)
{
SelectedConv.captionText.text = List[SelectedConv.value].conv_id;
}
}
catch (Exception ex)
{
Toast.Show(Utils.t("getConvListFailed"));
}
}
void ConvGetConvListSDK()
{
TIMResult res = TencentIMSDK.ConvGetConvList(Utils.addAsyncStringDataToScreen(GetConvList));
print($"ConvGetConvListSDK {res}");
}
void ConvPinConversationSDK()
{
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.ConvPinConversation(conv_id, conv_type, PinToggle.isOn, Utils.addAsyncNullDataToScreen(GetResult));
Result.text = Utils.SynchronizeResult(res);
}
void GetResult(params object[] parameters)
{
Result.text += (string)parameters[0];
}
void CopyText()
{
Utils.Copy(Result.text);
}
void OnApplicationQuit()
{
TencentIMSDK.Uninit();
}
}