ConvGetTotalUnreadMessageCount
功能介绍
获取全部会话未读数
用户的会话列表中一般会有若干个会话,如果某个会话收到了新消息,通常需要在列表的 cell 中以小红点或者数字角标的方式,向用户展示该会话的未读消息数,提醒用户尚未阅读。
用户点击进入该会话后退回到会话列表,未读消息数被清空,小红点消失。
部分应用还会统计所有会话的未读消息总数之和,将其展示在会话列表的底部 tab 上。
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callback | ValueCallback< GetTotalUnreadNumberResult > | 是 | 异步回调 返回值的json_param的格式为json |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:'{"conv_get_total_unread_message_count_result_unread_count":4}' //json key 请参考 [GetTotalUnreadNumberResult]
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样 json key 请参考 GetTotalUnreadNumberResult |
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;
public class ConvGetTotalUnreadMessageCount : MonoBehaviour
{
public Text Header;
public Text Result;
public Button Submit;
public Button Copy;
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(ConvGetTotalUnreadMessageCountSDK);
Copy.onClick.AddListener(CopyText);
}
void ConvGetTotalUnreadMessageCountSDK()
{
TIMResult res = TencentIMSDK.ConvGetTotalUnreadMessageCount(Utils.addAsyncStringDataToScreen(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();
}
}