FriendshipAddToBlackList
introduction
Add to blacklist
To block a user's messages, add the user to the blocklist.
Blocked user won't be notified by default, and he/she can still send messages without any error code returned.
If you wish to return certain error codes, please go to IM Console >【Feature Configuration】>【Login and Message】>【Blocklist Check】and disable Show "Sent successfully" After Sending Messages. Then SDK will return 20007 error code when blocked user sends messages.
Parameter details
overload1
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| json_add_to_blacklist_param | List< string > | Required | Add to blacklist param, User ID list |
| callback | ValueCallback< List< FriendResult > > | Required | Asynchronous callback The format of json_param in the return value is json |
overload2
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| json_add_to_blacklist_param | List< string > | Required | Add to blacklist param, User ID list |
| 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:
'[
{
"friend_result_code" : 0,
"friend_result_desc" : "OK",
"friend_result_identifier" : "user5"
},
{
"friend_result_code" : 0,
"friend_result_desc" : "OK",
"friend_result_identifier" : "user10"
}
]'// For the meaning of Json Key, please refer to [FriendResult]
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 FriendResult |
| 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 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.Text;
using System.Collections.Generic;
public class FriendshipAddToBlackList : MonoBehaviour
{
string[] Labels = new string[] { "SelectFriendLabel" };
public Text Header;
public Dropdown SelectedFriend;
public Text Result;
public Button Submit;
public Button Copy;
private List<string> FriendList;
void Start()
{
foreach (string label in Labels)
{
GameObject.Find(label).GetComponent<Text>().text = Utils.t(label);
}
FriendshipGetFriendProfileListSDK();
Header = GameObject.Find("HeaderText").GetComponent<Text>();
SelectedFriend = GameObject.Find("Friend").GetComponent<Dropdown>();
Result = GameObject.Find("ResultText").GetComponent<Text>();
Submit = GameObject.Find("Submit").GetComponent<Button>();
Copy = GameObject.Find("Copy").GetComponent<Button>();
Submit.onClick.AddListener(FriendshipAddToBlackListSDK);
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 GetFriendList(params object[] parameters)
{
try
{
FriendList = new List<string>();
SelectedFriend.ClearOptions();
string text = (string)parameters[1];
List<FriendProfile> List = Utils.FromJson<List<FriendProfile>>(text);
foreach (FriendProfile item in List)
{
print(item.friend_profile_identifier);
FriendList.Add(item.friend_profile_identifier);
var option = new Dropdown.OptionData();
option.text = item.friend_profile_identifier;
SelectedFriend.options.Add(option);
}
if (List.Count > 0)
{
SelectedFriend.captionText.text = List[SelectedFriend.value].friend_profile_identifier;
}
}
catch (Exception ex)
{
Toast.Show(Utils.t("getFriendListFailed"));
}
}
void FriendshipGetFriendProfileListSDK()
{
TIMResult res = TencentIMSDK.FriendshipGetFriendProfileList(Utils.addAsyncStringDataToScreen(GetFriendList));
print($"FriendshipGetFriendProfileListSDK {res}");
}
void FriendshipAddToBlackListSDK()
{
print(FriendList[SelectedFriend.value]);
List<string> list = new List<string>
{
FriendList[SelectedFriend.value]
};
TIMResult res = TencentIMSDK.FriendshipAddToBlackList(list, Utils.addAsyncStringDataToScreen(GetResult));
Result.text = Utils.SynchronizeResult(res);
}
void GetResult(params object[] parameters)
{
FriendshipGetFriendProfileListSDK();
Result.text += (string)parameters[0];
}
void CopyText()
{
Utils.Copy(Result.text);
}
void OnApplicationQuit()
{
TencentIMSDK.Uninit();
}
}