iOS

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

Before you begin

Select Method to add Kakao Talk Channel

Follow Kakao Talk Channel and Add Kakao Talk Channel are available. Refer to Add Kakao Talk Channel and decide what to use. Follow Kakao Talk Channel is recommended because of the easy implementation.

Follow Kakao Talk Channel

Basic information

Requests adding Kakao Talk Channel to the user. Displays a screen for adding Kakao Talk Channel and returns the result in the response.

Request

Request followChannel() in TalkApi. Kakao Talk Channel profile ID is required. Refer to Services using Kakao Login and Services not using Kakao Login for the request process.

Response

If the request is successful, FollowChannelResult in the response includes the Kakao Talk Channel profile ID and the result. If the request fails, refer to Trouble shooting to figure out the reason.

Sample

// Follow Kakao Talk Channel
TalkApi.shared.followChannel(channelPublicId: "${CHANNEL_PUBLIC_ID}") { result, error in
  if let error = error {
    print(error)
    // Fail
  }
  else {
    print(result)
    // Success
    ...
  }
}

let disposeBag = DisposeBag()

// Follow Kakao Talk Channel
UserApi.shared.rx.followChannel(channelPublicId:"${CHANNEL_ID}")
    .subscribe(onSuccess: { (result) in
        print("followChannel(channelPublicId:) success.")
        // Success
        ...
    }, onFailure: { error in
        print(error)
        // Fail
    })
    .disposed(by: disposeBag)

Add Kakao Talk Channel

Basic information

Launches Kakao Talk to let the user add the Kakao Talk Channel.

Request

Call addChannel() in TalkApi. Pass the profile ID of the Kakao Talk Channel.

Response

This API does not inform whether the user adds the Kakao Talk Channel. To check the added status, use the Checking Kakao Talk Channel relationship API that shows the relationship between a user and a Kakao Talk Channel.

Sample

TalkApi.shared.addChannel(channelPublicId: "${CHANNEL_ID}") {
  if let error = error {
    print(error)
  } else {
     print("addChannel() success.")
    // Implement service logics
    ...
  }
}

let disposeBag = DisposeBag()

TalkApi.shared.rx.addChannel(channelPublicId: "${CHANNEL_ID}")
  .subscribe(onCompleted:{
    print("addChannel() success")
    //do something
    ...
  }, onError: {error in
    print(error)
  })
  .disposed(by: disposeBag)

Additional feature

Bridge page

ReactiveX iOS SDK does not support this feature.

To send the user to a bridge page before launching Kakao Talk, use makeUrlForAddChannel(). Pass the profile ID of the Kakao Talk Channel. To open the url, use the present() method in safariViewController.

//in ViewController
var safariViewController : SFSafariViewController? // to keep instance
...

self.safariViewController = SFSafariViewController(url: TalkApi.shared.makeUrlForAddChannel(channelPublicId:"{channel-id}")!)

guard (self.safariViewController != nil) else { return }

self.safariViewController?.modalTransitionStyle = .crossDissolve
self.safariViewController?.modalPresentationStyle = .overCurrentContext
self.present(self.safariViewController!, animated: true) {
    print("Succeeded in opening a bridge page to add Kakao Talk Channel.")
}

Start Kakao Talk Channel chat

Basic information

Starts a chat with Kakao Talk Channel.

Request

Call chatChannel() in TalkApi. Pass the profile ID of the Kakao Talk Channel.

Response

This API does not inform whether the user enters the chat room successfully.

Sample

TalkApi.shared.chatChannel(channelPublicId: "${CHANNEL_ID}") {
  if let error = error {
    print(error)
  } else {
     print("chatChannel() success.")
    // Implement service logics
    ...
  }
}

let disposeBag = DisposeBag() 

TalkApi.shared.rx.chatChannel(channelPublicId: "${CHANNEL_ID}")
  .subscribe(onCompleted:{
    print("chatChannel() success")
    //do something
    ...
  }, onError: {error in
    print(error)
  })
  .disposed(by: disposeBag)

Additional feature

Bridge page

ReactiveX iOS SDK does not support this feature.

To send the user to a bridge page before launching Kakao Talk, use makeUrlForChatChannel(). Pass the profile ID of the Kakao Talk Channel. To open the URL, use the present() method in safariViewController.

//in ViewController
var safariViewController : SFSafariViewController? // to keep instance
...

self.safariViewController = SFSafariViewController(url: TalkApi.shared.makeUrlForChatChannel(channelPublicId:"{channel-id}")!)

guard (self.safariViewController != nil) else { return }

self.safariViewController?.modalTransitionStyle = .crossDissolve
self.safariViewController?.modalPresentationStyle = .overCurrentContext
self.present(self.safariViewController!, animated: true) {
    print("Succeeded in opening a bridge page to add Kakao Talk Channel.")
}

Check Kakao Talk Channel relationship

Basic information

Checks if a specific user has added or blocked the Kakao Talk Channel connected to the service app.

Request

Call the channels() method defined in the TalkApi class.

Make sure that this API only informs the relationship between the user and the Kakao Talk Channel connected to the app that made a request. Thus, you cannot get all Kakao Talk Channels' information that the user has added but the channels related to your service only.

Response

If the request is successful, channels() returns the Channels object.

Sample

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

// Class member property
let disposeBag = DisposeBag()

TalkApi.shared.rx.channels()
    .retry(when: Auth.shared.rx.incrementalAuthorizationRequired())
    .subscribe (onSuccess:{ (channels) in
        print("channels() success.")        
        // Implement service logics
        _ = channels
    }, onFailure: {error in
        print(error)
    })
    .disposed(by: disposeBag)