FriendshipGetFriendsInfo
introduction
Get friends' info
json_get_friends_info_param length maximum 100, for too much data in one package the connection may be rejected for the maximum size of data package is 1M.
What should I do if the user profile obtained in the Enhanced edition is not the latest?
Friend's profile: When the profile of a friend is updated, the backend will send a system notification to the SDK, so the profile will be updated in real time.
Non-friend user's profile: When the profile of a non-friend user is updated, the backend cannot send a system notification to the SDK; therefore, the profile cannot be updated in real time. To avoid sending a network request to the backend every time the user profile is obtained, the SDK adds the caching logic and allows a user to pull the profile from the backend every ten minutes.
Parameter details
overload1
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| json_get_friends_info_param | List< string > | Required | Parameters for searching friend info |
| callback | ValueCallback< List< FriendInfoGetResult > > | Required | Asynchronous callback The format of json_param in the return value is json |
overload2
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| json_get_friends_info_param | List< string > | Required | Parameters for searching friend info |
| 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:
'[
{
"friendship_friend_info_get_result_error_code": 0,
"friendship_friend_info_get_result_error_message": "OK",
"friendship_friend_info_get_result_field_info": {
"friend_profile_add_source": "",
"friend_profile_add_time": 0,
"friend_profile_add_wording": "",
"friend_profile_custom_string_array": [{
"friend_profile_custom_string_info_key": "Tag_Profile_Custom_Str",
"friend_profile_custom_string_info_value": "test3-lamar-value"
}],
"friend_profile_group_name_array": [],
"friend_profile_identifier": "98826",
"friend_profile_remark": "",
"friend_profile_user_profile": {
"user_profile_add_permission": 1,
"user_profile_birthday": 2000,
"user_profile_custom_string_array": [{
"user_profile_custom_string_info_key": "Tag_Profile_Custom_Str",
"user_profile_custom_string_info_value": "test3-lamar-value"
}],
"user_profile_face_url": "test1-www.google.com",
"user_profile_gender": 2,
"user_profile_identifier": "98826",
"user_profile_language": 1000,
"user_profile_level": 3000,
"user_profile_location": "shenzhen",
"user_profile_nick_name": "test change8888",
"user_profile_role": 4000,
"user_profile_self_signature": "1111111"
}
},
"friendship_friend_info_get_result_identifier": "98826",
"friendship_friend_info_get_result_relation_type": 0
}
]' // For the meaning of Json Key, please refer to [FriendInfoGetResult]
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. For the meaning of Json Key, please refer to FriendInfoGetResult |
| 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 UnityEngine.SceneManagement;
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 System.Collections;
using System.Collections.Generic;
using EasyUI.Toast;
public class FriendshipGetFriendsInfo : MonoBehaviour
{
public List<FriendProfile> UserList = new List<FriendProfile>();
public HashSet<string> SelectedUser = new HashSet<string>();
public Text Header;
public Text Result;
public Button Submit;
public Button Copy;
void Start()
{
GameObject.Find("SelectUserLabel").GetComponent<Text>().text = Utils.t("SelectUserLabel");
FriendshipGetFriendProfileList();
Header = GameObject.Find("HeaderText").GetComponent<Text>();
Result = GameObject.Find("ResultText").GetComponent<Text>();
Submit = GameObject.Find("Submit").GetComponent<Button>();
Copy = GameObject.Find("Copy").GetComponent<Button>();
Submit.onClick.AddListener(FriendshipGetFriendsInfoSDK);
Copy.GetComponentInChildren<Text>().text = Utils.t("Copy");
Copy.onClick.AddListener(CopyText);
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 ToggleValueChanged(Toggle change)
{
string userID = change.GetComponentInChildren<Text>().text.Split(':')[1];
if (change.isOn)
{
SelectedUser.Add(userID);
}
else
{
SelectedUser.Remove(userID);
}
}
void GenerateToggle()
{
var Parent = GameObject.Find("ToggleContent");
var Toggler = GameObject.Find("Toggler").GetComponent<Toggle>();
foreach (FriendProfile user in UserList)
{
var obj = Instantiate(Toggler, Parent.transform);
obj.GetComponentInChildren<Text>().text = "userID:" + user.friend_profile_identifier;
obj.isOn = false;
obj.onValueChanged.AddListener(delegate
{
ToggleValueChanged(obj);
});
}
}
void SetUserList(params object[] parameters)
{
try
{
string text = (string)parameters[1];
print(text);
List<FriendProfile> List = Utils.FromJson<List<FriendProfile>>(text);
UserList.AddRange(List);
GenerateToggle();
}
catch (Exception ex)
{
print(ex);
Toast.Show(Utils.t("getFriendListFailed"));
}
}
public void FriendshipGetFriendProfileList()
{
var Users = UserList;
var cb = Utils.addAsyncStringDataToScreen(SetUserList);
TIMResult res = TencentIMSDK.FriendshipGetFriendProfileList(cb);
}
public void FriendshipGetFriendsInfoSDK()
{
List<string> user_list = new List<string>(SelectedUser);
TIMResult res = TencentIMSDK.FriendshipGetFriendsInfo(user_list, 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();
}
}