• UIKit
  • SDK
  • 서버 API
Chat/
SDK/
Web/
사용자 정보 및 관계망/
SDK
  • Chat SDK 설치
  • Chat SDK 초기화
  • 로그인 및 로그아웃
  • 고객 인터페이스
  • Changelog
  • 메시지
    • 개요
    • 메시지 보내기
    • 메시지 받기
    • 과거 메시지
    • 메시지 전달
    • 메시지 수정
    • 메시지 삭제
    • 과거 메시지 비우기
    • 메시지 철회
    • 온라인 메시지 보내기
    • 메시지 읽음 확인
    • 메시지 조회
    • 지향적 그룹 메시지
    • 알림 차단
    • Key-Value 확장
    • 번역
  • 대화
    • 개요
    • 대화 목록
    • 대화 획득
    • 읽지 않은 메시지 수
    • 대화 최상단 고정
    • 대화 삭제
    • 마크
    • 대화 그룹
  • 그룹
    • 개요
    • 그룹 관리
    • 그룹 정보
    • 그룹 멤버 관리
    • 그룹 멤버 정보
    • 그룹 속성 사용자 정의
    • 그룹 카운터
  • 커뮤니티 화제
    • 커뮤니티 관리
  • 사용자 정보 및 관계망
    • 사용자 정보
    • 사용자 상태
    • 친구 관리
    • 친구 목록
    • 블록리스트
  • Guideline for Beginners
  • 콘솔 안내
    • 애플리케이션 생성 및 업그레이드
    • 기본 구성
    • 기능 구성
    • 계정 관리
    • 그룹 관리
    • 콜백 구성
  • 제품 소개
    • 메시지 관리
      • 1대1 메시지
      • 메시지 저장
      • 오프라인 푸시
      • 그룹 메시지
      • 메시지 포맷
    • 계정 시스템
      • 로그인 인증
      • 온라인 상태 관리
    • 그룹 관련
      • 그룹 시스템
      • 그룹 관리
    • 사용자 정보 및 관계망
      • 정보 관리
      • 관계망 관리
  • 구매 가이드
    • 과금 개요
    • 가격
  • 에러코드
이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

친구 목록

Feature Description

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

Creating a friend group

API
chat.createFriendGroup(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
name
String
List name
userIDList
Array
List of userID values of the friends to be added to the group
Returned value
Promise
Sample
let promise = chat.createFriendGroup({
name: 'My friend group 1',
userIDList: ['user0','user1']
});
promise.then(function(imResponse) {
const { friendGroup,failureUserIDList } = imResponse;
// friendGroup - Friend list instance
// failureUserIDList - List of the `userID` values failed to be added
// When the friend group is successfully created
// the SDK triggers the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
}).catch(function(imError) {
console.warn('getFriendGroupInfo error:', imError); // Failed to obtain the information
});

Deleting a friend group

API
chat.deleteFriendGroup(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
name
String
group name
Returned value
Promise
Sample
let promise = chat.deleteFriendGroup({
name: 'My friend group 1',
});
promise.then(function(imResponse) {
console.log(imResponse.data); // Friend list instance
// When the friend group is successfully deleted
// the SDK triggers the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
}).catch(function(imError) {
console.warn('deleteFriendGroup error:', imError); // Failed to obtain the information
});

Renaming a friend group

API
chat.renameFriendGroup(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
oldName
String
Old group name
newName
String
New group name
Returned value
Promise
Sample
let promise = chat.renameFriendGroup({
oldName: 'Friends',
newName: 'Besties'
});
promise.then(function(imResponse) {
console.log(imResponse.data); // FriendGroup instance
// When the name of a friend group is changed successfully
// the SDK triggers the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
}).catch(function(imError) {
console.warn('updateMyProfile error:', imError);
});

Getting a friend group

The friend groups cached in the SDK can be obtained. When a friend group is updated, the SDK will deliver the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
API
chat.getFriendGroupList();
Returned value
Promise
Sample
let promise = chat.getFriendGroupList();
promise.then(function(imResponse) {
const friendGroupList = imResponse.data; // Friend list
}).catch(function(imError) {
console.warn('getFriendGroupList error:', imError); // Failed to obtain the friend group
});

Adding a friend to a list

API
chat.addToFriendGroup(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
name
String
Group name
userIDList
Array
List of userID values of the friends to be added
Returned value
Promise
Sample
let promise = chat.addToFriendGroup({
name: 'My friend group 1',
userIDList: ['user1','user2'],
});
promise.then(function(imResponse) {
const { friendGroup, failureUserIDList } = imResponse.data;
// friendGroup - Friend list instance
// failureUserIDList - List of the `userID` values failed to be added
// When the friends are successfully added to the friend group,
// the SDK triggers the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
}).catch(function(imError) {
console.warn('addToFriendGroup error:', imError); // Failed to obtain the information
});

Removing a friend from a list

API
chat.removeFromFriendGroup(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
name
String
Group name
userIDList
Array
List of userID values of the friends to be removed
Returned value
Promise
Sample
let promise = chat.removeFromFriendGroup({
name: 'My friend group 1',
userIDList: ['user1','user2'],
});
promise.then(function(imResponse) {
const { friendGroup, failureUserIDList } = imResponse.data;
// friendGroup - Friend list instance
// failureUserIDList - List of the `userID` values failed to be added
// When the friends are successfully removed from the friend group
// the SDK triggers the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
}).catch(function(imError) {
console.warn('addToFriendGroup error:', imError); // Failed to obtain the information
});