please select
  • UIKit
  • SDK
  • Server APIs
Chat/
SDK/
React Native/
User/
SDK
  • Run Demo
  • SDK Integration
  • Initialization
  • Login and Logout
  • Message
    • Message Overview
    • Sending Message
    • Receiving Message
    • Historical Message
    • Forwarding Message
    • Modifying Message
    • Message Inserting
    • Deleting Message
    • Clearing Messages
    • Recalling Message
    • Online Message
    • Read Receipt
    • Querying Message
    • Group @ Message
    • Targeted Group Message
    • Notification Muting
    • Message Extension
  • Group
    • Overview
    • Group Management
    • Group Profile
    • Group Member Management
    • Group Member Profile
    • Custom Group Attribute
    • Community Management
  • User
    • User Profile
    • Friend Management
    • Friend List
    • Blocklist
  • Offline Push
    • Offline Push
  • Local Search
    • Searching for Message
    • Searching for Friend
    • Searching Group
    • Searching for Group Member
  • Signaling
    • Signaling Management
  • Changelog
  • Guideline for Beginners
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes
Docs Overview/
Chat/
SDK/
React Native/
User/
Friend List/

Friend List

Feature Description

To group friends into categories such as "Classmates at university" and "Coworkers", call the following APIs.

Friend List

Creating a friend list

Call the createFriendGroup API (Details) to create a friend list.
Sample code:
// Create a friend list and add a friend to the list
const groupName = "Friend list 1";
const userIDList = ["user1"];
const friendgroups = await friendshipManager.createFriendGroup(
  groupName,
  userIDList
);

Deleting a friend list

Call the deleteFriendGroup API (Details) to delete a friend list.
Sample code:
// Delete a friend list
const deleteFriendsgroup = await friendshipManager.deleteFriendGroup(["Friend list 1"]);

Renaming a friend list

Call the renameFriendGroup API (Details) to rename a friend list.
Sample code:
// Rename a friend list
const rename = await friendshipManager.renameFriendGroup("New friend list 1", "Friend list 1");

Getting a friend list

Call the getFriendGroups API (Details) to get a friend list.
Sample code:
// Get the information of a friend list by list name
const friendGrous = await friendshipManager.getFriendGroups(["Friend list 1"]);

Adding a friend to a list

Call the addFriendsToFriendGroup API (Details) to add a friend to a list.
Sample code:
// Add a friend to a friend list
const groupName = ["Friend list 1"];
const userIDList = ["user1"];
const addToFrindgroups = await friendshipManager.addFriendsToFriendGroup(
  groupName,
  userIDList
);

Removing a friend from a list

Call deleteFriendsFromFriendGroup (Details) to remove a friend from a list.
Sample code:
// Remove a friend from a list
const groupName = ["Friend list 1"];
const userIDList = ["user1"];
const deletefromFriendsGrousps =
  await friendshipManager.deleteFriendsFromFriendGroup(groupName, userIDList);