ProfileGetUserProfileList
introduction
Get user profile list
Call the ProfileGetUserProfileList API (c#) and enter the UserID of a non-friend user for the friendship_getprofilelist_param_identifier_array parameter to query the profile of the non-friend user.
Get user profile, including self profile.
The profile of a non-friend user cannot be modified.
Parameter details
overload1
Parameter name | Parameter type | Required | Description |
---|---|---|---|
json_get_user_profile_list_param | FriendShipGetProfileListParam | Required | FriendShipGetProfileListParam |
callback | ValueCallback< List< UserProfile > > | Required | Asynchronous callback The format of json_param in the return value is json |
overload2
Parameter name | Parameter type | Required | Description |
---|---|---|---|
json_get_user_profile_list_param | FriendShipGetProfileListParam | Required | FriendShipGetProfileListParam |
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:
'[
{
"user_profile_add_permission" : 1,
"user_profile_birthday" : 0,
"user_profile_face_url" : "",
"user_profile_gender" : 0,
"user_profile_identifier" : "user1",
"user_profile_language" : 0,
"user_profile_level" : 0,
"user_profile_location" : "",
"user_profile_nick_name" : "User1NickName",
"user_profile_role" : 0,
"user_profile_self_signature" : ""
},
{
"user_profile_add_permission" : 0,
"user_profile_birthday" : 0,
"user_profile_face_url" : "",
"user_profile_gender" : 0,
"user_profile_identifier" : "user2",
"user_profile_language" : 0,
"user_profile_level" : 0,
"user_profile_location" : "",
"user_profile_nick_name" : "",
"user_profile_role" : 0,
"user_profile_self_signature" : ""
}
]' // For the meaning of Json Key, please refer to [UserProfile]
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 UserProfile |
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 ProfileGetUserProfileList : 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(ProfileGetUserProfileListSDK);
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 ProfileGetUserProfileListSDK()
{
FriendShipGetProfileListParam json_get_user_profile_list_param = new FriendShipGetProfileListParam();
json_get_user_profile_list_param.friendship_getprofilelist_param_identifier_array = new List<string>(SelectedUser);
TIMResult res = TencentIMSDK.ProfileGetUserProfileList(json_get_user_profile_list_param, 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();
}
}