Picker

Kakao. Namespace

Picker

Description:

  • 피커 API 모듈
    Module for the picker APIs

Methods

(static) cleanup()

Description:

  • 사용한 피커 모듈 리소스 해제
    Cleans up used picker module resources

(static) selectFriend(settings) → {Promise.<(FriendsPickerResponse|PickerError)>}

Description:

  • 싱글 피커 요청
    Requests a single picker

See:
Example
Kakao.Picker.selectFriend({
  title: '친구 선택',
  showMyProfile: false,
})
  .then(function(response) {
    console.log(response)
  })
  .catch(function(error) {
    console.error(error)
  })
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
title String <optional>
 "카카오톡 친구 선택"

피커 이름
Name of the picker
enableSearch Boolean <optional>
 true

검색 기능 사용 여부
Enables the search function
showMyProfile Boolean <optional>
 true

내 프로필 표시 여부
Displays my profile
showFavorite Boolean <optional>
 true

즐겨찾기 친구 표시 여부
Marks on favorite friends
enableBackButton Boolean <optional>
 true

뒤로 가기 버튼 사용 여부
Enables the back button
returnUrl String <optional>

친구 정보를 받을 URL, 리다이렉트 방식 사용 시 필수
URL to get the friend information, required for redirect method
Returns:
Type
Promise.<(FriendsPickerResponse|PickerError)>

(static) selectFriends(settings) → {Promise.<(FriendsPickerResponse|PickerError)>}

Description:

  • 멀티 피커 요청
    Requests a multi-picker

See:
Example
Kakao.Picker.selectFriends({
  title: '친구 선택',
  showMyProfile: false,
  maxPickableCount: 10,
  minPickableCount: 1,
})
  .then(function(response) {
    console.log(response)
  })
  .catch(function(error) {
    console.error(error)
  })
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
title String <optional>
 "카카오톡 친구 선택"

피커 이름
Name of the picker
enableSearch Boolean <optional>
 true

검색 기능 사용 여부
Enables the search function
showMyProfile Boolean <optional>
 true

내 프로필 표시 여부
Displays my profile
showFavorite Boolean <optional>
 true

즐겨찾기 친구 표시 여부
Marks on favorite friends
showPickedFriend Boolean <optional>
 true

선택한 친구 표시 여부, 멀티 피커에만 사용 가능
Displays selected friends for multi-picker
maxPickableCount Number <optional>
 30

선택 가능한 최대 대상 수, minPickableCount보다 크거나 같은 수 (최대: 100)
Maximum pickable count, greater than or equal to minPickableCount (Maximum: 100)
minPickableCount Number <optional>
 1

선택 가능한 최소 대상 수, maxPickableCount보다 작거나 같은 수 (최대: 100)
Minimum pickable count, less than or equal to maxPickableCount (Maximum: 100)
enableBackButton Boolean <optional>
 true

뒤로 가기 버튼 사용 여부
Enables the back button
returnUrl String <optional>

친구 정보를 받을 URL, 리다이렉트 방식 사용 시 필수
URL to get the friend information, required for redirect method
Returns:
Type
Promise.<(FriendsPickerResponse|PickerError)>

Type Definitions

FriendsPickerResponse

Description:

  • 선택한 사용자 정보 목록
    A list of the selected user information

Properties:
Name Type Description
response Object
Properties
Name Type Description
selectedTotalCount Number

선택한 사용자 수
Number of selected users
users Array.<SelectedUser>

선택한 사용자 정보 목록, 정보 제공이 불가능한 사용자 제외
A list of the selected user information, except for unavailable user information

선택한 사용자 정보 목록
A list of the selected user information

Type:
  • Object

PickerError

Description:

  • 피커 에러
    Picker error

Properties:
Name Type Description
error Object
Properties
Name Type Description
code String

에러 코드
Error code
msg String

에러 메시지
Error message

피커 에러
Picker error

Type:
  • Object

SelectedUser

Description:

  • 선택한 사용자 정보
    Selected user information

Properties:
Name Type Attributes Description
uuid String

고유 ID
Unique ID
id String <nullable>

회원번호, 앱과 연결된 사용자에게만 존재
Service user ID, only provided for users linked with the app
profile_nickname String <nullable>

프로필 닉네임
Profile nickname
profile_thumbnail_image String <nullable>

프로필 썸네일 이미지
Profile thumbnail image
favorite Boolean <nullable>

즐겨찾기 친구 여부
Whether a favorite friend

선택한 사용자 정보
Selected user information

Type:
  • Object