앱친구

친구 API는 앱에 가입한 카카오톡 친구 중 정보 제공에 동의한 사용자 목록을 제공하는 API를 의미합니다. 카카오계정으로 로그인을 하는 앱에서 사용할 수 있습니다.

  • 앱에 가입된 친구만 대상이 됩니다.
  • 친구 정보 제공에 동의한 친구만 목록에 포함되고, 친구 리스트 중 친구 정보 제공에 동의하지 않은 경우 목록에서 제외됩니다.

현재 제공되는 API는 다음과 같습니다.

친구목록 조회

친구 정보가 많을 수 있기 때문에 사용하는 클라이언트에서는 paging 기반으로 요청해야 합니다. 이를 위해 페이징을 위한 KOAppFriendContext 생성 파라미터로 limit 이 제공되고 전달한 limit 개수 만큼의 결과를 가져옵니다. limit의 기본 값과 최대 값은 100입니다.

해당 paging 기반 요청을 기준으로 더 불러올 친구 목록이 있는 경우 컨텍스트의 hasMoreItems 값이 true이며, 이 컨텍스트를 그대로 전달하여 appFriendsWithContext:completionHandler: 메소드를 호출하면 다음 페이지(limit 개수)의 친구 목록을 가져올 수 있습니다.

// limit: 20, ordering: ascending
//KOAppFriendContext *context = [KOAppFriendContext contextWithLimit:20 order:KOOrderingAscending];

// limit: 100 (서버 최대 값), ordering: descending
//KOAppFriendContext *context = [KOAppFriendContext contextWithLimit:200 order:KOOrderingDescending];

// 기본 값
// limit: 100, ordering: ascending
KOAppFriendContext *context = [KOAppFriendContext context];

[KOSessionTask appFriendsWithContext:context
                   completionHandler:^(void (^)(NSError *error, NSArray<KOAppFriend *> *appFriends) {
                       if (error) {
                           switch (error.code) {
                           case KOServerErrorNotTalkUser:
                               // 로그인 된 사용자가 카카오톡 사용자가 아님
                               break;
                           default:
                               // 그 외 에러
                               break;
                           }
                       } else {
                           // 성공
                           if (context.hasMoreItems) {
                               // 다음 목록 있음
                           }
                       }
                   }];

Last Modified : 2018-08-23