This document describes how to integrate Kakao Talk Social APIs into your service with the Kakao SDK for iOS ("iOS SDK").

Retrieves Kakao Talk profile information linked to the Kakao Account of the logged-in user.

You can check the types and differences of user profiles available through the Kakao API in User profile.

Call profile().

profile() returns the TalkProfile object which contains the user's Kakao Talk profile information.

The Kakao Talk profile obatained though profile() is different from the profile of Kakao Account. Refer to Concepts.

TalkApi.shared.profile {(profile, error) in
    if let error = error {
        print(error)
    } else {
        print("profile() success.")

        // Implement service logics
        _ = profile
    }
}

Opens the Friend picker and returns the information of the Kakao Talk friends selected by the user.

Call selectFriend() to open the Friend picker.

Use viewType to set the display format to full screen (.full) or popup view (.popup).

Create the SelectParams configuration object and pass it to selectParams to set the Friend picker type (selectionMode) and the number of selectable friends (minPickableCount, maxPickableCount).

If selectionMode is .single (single picker), the minimum and maximum selection counts are fixed to 1. If selectionMode is .multiple (multi-picker), the selectable range can be set from 1 to 100 (default: minimum 1, maximum 30). See How to create SelectParams.

Other detailed settings such as picker orientation and search function can be modified by specifying OpenPickerFriendRequestParams. For more information on parameters, refer to the reference and Friend picker custom elements.

For the iOS Friend picker, you can create SelectParams directly or use a helper method. Pass the directly created value or the value created by the friend() method to selectParams. When you use the method, default values are applied to unspecified selection parameters. See the example below for direct creation and the request sample for using the method.

// Example of creating SelectParams directly
let selectParams = SelectParams(selectionMode: .multiple, maxPickableCount: 7)
let requestParams = OpenPickerFriendRequestParams(selectParams: selectParams)

If the request is successful, the information of the friends that a user selects from the Friend picker is returned through SelectedUsers. If you encounter errors, refer to Error code.

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Single picker", // Name of the picker
    friendFilter: PickerFriendFilter.registered, // Friend list filter
    viewAppearance: .auto, // Display mode
    orientation: .auto, // Picker orientation
    selectParams: .friend(
        selectionMode: .single
.single: Single picker, .multiple: Multi-picker
    )
)

PickerApi.shared.selectFriend(
    params: openPickerFriendRequestParams,
    viewType: .full
.full: Full screen, .popup: Popup view
) { [weak self] selectedUsers, error in
    if let error = error {
        print(error)
    } else {
        print("selectFriend(params:) success.")

        // Implement actions on success
        _ = selectedUsers
    }
}

Retrieves Kakao Talk friend information linked to the Kakao Account of the logged-in user.

Note that Kakao Talk profiles may be different from Kakao Account profiles. Refer to Concepts.

To get the list of Kakao Talk friends of the user currently logged in, call the friends() method in the TalkApi class. You can also pass optional parameters through arguments. If you make a request without any parameters, the default settings are applied.

friends() returns Friends which contains a list of the user's Kakao Talk friends.

If the request fails because the user has not agreed to provide the Friends list, proceed the followings:

• Check if 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' is set to 'Consent during use' in Consent items.
• Request additional consent to the 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' scope.

TalkApi.shared.friends {(friends, error) in
    if let error = error {
        print(error)
    }
    else {
        // Implement service logics
        _ = friends
    }
}

To retrieve the response in the page format, use FriendsContext. FriendsContext includes same paramaeters. When the number of Kakao Talk friends is more than the specified value or default value(100), the response will be returned in the page format. After the first page, use FriendsContext to retrieve the second page.