Kakao Developers

Picker

Description:

피커와 관련된 함수들이 포함되어 있습니다.

Methods

(static) cleanup()

Description:

피커를 호출하기 위해 사용한 리소스를 해제합니다.

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

Description:

한 명의 친구를 선택할 때 사용합니다.

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

친구 피커와 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Attributes	Default	Description
`title`	String	<optional>	`"카카오톡 친구 선택"`	친구 피커 타이틀 영역에 표시될 텍스트
`enableSearch`	Boolean	<optional>	`true`	검색 기능 사용 여부
`showMyProfile`	Boolean	<optional>	`true`	내 프로필 표시 여부
`showFavorite`	Boolean	<optional>	`true`	즐겨찾기 표시 여부
`enableBackButton`	Boolean	<optional>	`true`	뒤로가기 버튼 노출 유무
`returnUrl`	String	<optional>		선택한 친구 정보를 받을 서비스 URL (리다이렉트 방식 사용 시 필수)

Returns:

Type: Promise.<(FriendsPickerResponse|PickerError)>

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

Description:

여러 명의 친구를 선택할 때 사용합니다.

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

친구 피커와 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Attributes	Default	Description
`title`	String	<optional>	`"카카오톡 친구 선택"`	친구 피커 타이틀 영역에 표시될 텍스트
`enableSearch`	Boolean	<optional>	`true`	검색 기능 사용 여부
`showMyProfile`	Boolean	<optional>	`true`	내 프로필 표시 여부
`showFavorite`	Boolean	<optional>	`true`	즐겨찾기 표시 여부
`showPickedFriend`	Boolean	<optional>	`true`	선택된 친구 표시 여부
`maxPickableCount`	Number	<optional>	`30`	최대 선택 가능 친구 수 (최대 100명)
`minPickableCount`	Number	<optional>	`1`	최소 선택 가능 친구 수 (최대 100명)
`enableBackButton`	Boolean	<optional>	`true`	뒤로가기 버튼 노출 유무
`returnUrl`	String	<optional>		선택한 친구 정보를 받을 서비스 URL (리다이렉트 방식 사용 시 필수)

Returns:

Type: Promise.<(FriendsPickerResponse|PickerError)>

Type Definitions

FriendsPickerResponse

Properties:

Name Type Description

response

Object

Properties

Name	Type	Description
`selectedTotalCount`	Number	피커에서 선택한 친구 수
`users`	Array.<SelectedUser>	피커에서 선택한 친구 정보

PickerError

Properties:

Name Type Description

error

Object

Properties

Name	Type	Description
`code`	String	에러 코드
`msg`	String	에러 메시지

SelectedUser

Properties:

Name	Type	Attributes	Description
`uuid`	String		고유 식별자
`id`	String	<nullable>	회원번호
`profile_nickname`	String	<nullable>	프로필 닉네임
`profile_thumbnail_image`	String	<nullable>	프로필 썸네일 이미지
`favorite`	Boolean	<nullable>	즐겨찾기 설정 여부