카카오톡 친구 선택하기

정보

API를 사용하려면 카카오 로그인을 완료하고 관련 동의 항목에 동의한 상태여야 합니다.

피커와 친구 목록 가져오기 API는 사용 권한을 받은 앱에서만 사용할 수 있습니다. 사용 권한을 받기 전에는 앱의 팀원만 이 기능을 사용할 수 있습니다. 실제 서비스에서 모든 사용자가 기능을 사용하게 하려면 [내 애플리케이션] > [앱 권한 신청]에서 사용 권한을 신청해야 합니다.

사용 권한 신청 방법은 공식 문서를 참고하세요.

동의 항목을 이용 중 동의로 설정하면 해당 API를 호출할 때 위 이미지처럼 권한 허용 안내가 표시됩니다.

mode='full'로 설정한 전체 화면 피커입니다.

mode='popup'으로 설정한 팝업 피커입니다.

친구 목록 색인

Android와 iOS에서는 enableIndex로 친구 목록의 색인을 켜거나 끌 수 있습니다. 기본값은 true입니다. false로 설정하면 색인을 사용하지 않습니다.

웹 JavaScript SDK는 이 옵션을 지원하지 않습니다. 웹에서는 enableIndex를 무시하고 SDK의 기본 친구 선택 화면을 엽니다.

import { selectMultipleFriends } from '@react-native-kakao/social';

const result = await selectMultipleFriends({
  mode: 'full',
  options: { enableIndex: false },
});

공통 타입들

친구 피커를 설정하는 옵션 객체와 친구 객체는 다음과 같이 정의됩니다.

export interface KakaoTalkFriendSelectOptions {
  /** 친구 피커 테마 */
  viewAppearance?: 'auto' | 'light' | 'dark';
  /** 친구 피커의 기기 방향 */
  orientation?: 'auto' | 'landscape' | 'portrait';
  /** 친구 검색 기능 사용 여부 */
  enableSearch?: boolean;
  enableIndex?: boolean;
  /** 내 프로필 표시 여부 */
  showMyProfile?: boolean;
  /** 즐겨찾기 친구 표시 여부 */
  showFavorite?: boolean;
  /** 선택한 친구 표시 여부 (멀티 피커에만 사용 가능) */
  showPickedFriend?: boolean;
  /** 선택 가능한 친구 수의 최대값 (멀티 피커에만 사용 가능) */
  maxPickableCount?: number;
  /** 선택 가능한 친구 수의 최소값 (멀티 피커에만 사용 가능) */
  minPickableCount?: number;
}

export interface KakaoTalkFriendProfile {
  /**
   * 해당 앱에서의 사용자 식별 코드 연결 상태와 관계 없으며 일반적으로 메시지 전송 시 사용 카카오톡을 탈퇴하거나
   * 새로 가입할 경우 값이 변경될 수 있음 사용자의 계정 상태에 따라 바뀔 수 있으므로, 앱에서 사용자 식별자로 사용하는 것을 권장하지 않음
   */
  uuid: string;
  /** 친구의 회원번호, 앱과 연결된 친구에게만 존재 */
  id?: number | null;
  /** 즐겨찾기 추가 여부, 채팅방 피커에서는 미제공 */
  favorite?: boolean | null;
  /** 마스킹된 프로필 닉네임. SDK 응답에 따라 제공되지 않거나 null일 수 있습니다. */
  maskingProfileNickname?: string | null;
  /** 프로필 닉네임, 프로필 닉네임 동의 항목에 동의하지 않은 친구나 앱과 연결되지 않는 친구의 경우,
   * 닉네임을 마스킹 처리하여 제공(닉네임 원본을 받으려면 권한 및 displayAllProfile 설정 필요) */
  profileNickname?: string | null;
  /**
   * 프로필 썸네일 이미지, 프로필 썸네일 이미지 동의 항목에 동의하지 않은 친구나 앱과 연결되지 않은 친구의 경우,
   * 프로필 이미지 미제공(프로필 이미지를 받으려면 권한 및 displayAllProfile 설정 필요)
   */
  profileThumbnailImage?: string | null;
}

단일 친구 선택하기

selectSingleFriend()를 이용해 친구 한 명을 선택할 수 있습니다.

이 함수는 다음과 같이 정의됩니다.

mode에 따라 피커가 전체 화면 또는 팝업으로 열립니다.

export async function selectSingleFriend(params: {
  mode: 'full' | 'popup';
  options?: KakaoTalkFriendSelectOptions;
}): Promise<KakaoTalkFriendProfile | undefined>

여러 친구 선택하기

selectMultipleFriends()를 이용해 여러 친구를 선택할 수 있습니다.

이 함수는 다음과 같이 정의됩니다.

mode에 따라 피커가 전체 화면 또는 팝업으로 열립니다.

export function selectMultipleFriends(params: {
  mode: 'full' | 'popup';
  options?: KakaoTalkFriendSelectOptions;
})