Getting Started

0. 최소 지원 사양

iOS 12.0 이상
Xcode 15.3 이상

2025년 4월 24일부터 앱 스토어 커넥트에 업로드하는 앱은 Xcode 16 이상 버전을 사용하여 빌드해야 합니다.

1. iOS SDK 추가

Klat SDK는 Cocoapods 또는 SPM (Swift Package Manager)를 통해서 설치할 수 있습니다.

1) 프로젝트의 Podfile을 열고 아래 내용을 추가합니다.
   pod 'talkplus-ios'

2) pod install 명령어를 사용하여 Klat SDK를 설치합니다.
   pod install --repo-update

1) Xcode에서 아래 메뉴를 클릭합니다.
   Xcode - File -> Add Package Dependencies...

2) 우측 상단 패키지 URL에 아래 저장소 주소를 입력합니다.
   https://github.com/adxcorp/talkplus-ios-release.git

3) 사용하려는 버전을 선택하고 "Add Package" 버튼을 클릭하여 SDK 설치를 완료합니다.

현재 최신 SDK 버전은 1.0.2 입니다.

SPM (Swift Package Manager) 경우, 0.6.3 버전부터 지원됩니다.

SDK 변경 이력

v1.0.2 (2025-03-06) : Xcode 16.0 버전에서 라이브러리 빌드 : iOS 최소 지원 버전 변경 (10.0 -> 12.0) v1.0.1 (2025-02-13) : 라이브러리 타입 변경 (Static -> Dynamic) v1.0.0 (2025-02-05) : Klat iOS SDK v1.0.0 배포

2. Initialize

1) Klat SDK를 사용하려면 다음과 같이 import합니다.

#import <TalkPlus/TalkPlus.h>

import TalkPlus

2) Klat SDK를 사용하기 전 AppDelegate 혹은 Main ViewController 에서 초기화 함수를 호출해줍니다.

[[TalkPlus sharedInstance] initWithAppId:@"YOUR_APP_ID"];

TalkPlus.sharedInstance()?.initWithAppId("YOUR_APP_ID")

Klat SDK는 매 실행시마다 login 함수(login:success:failure:)의 호출이 필요합니다.
login이 이루어진 후 logout이 호출되기 전까지 등록된 FCM Token은 유지됩니다. 따라서 오프라인 상태에 들어간 경우에도 Push Notification을 받을 수 있습니다.
사용자가 logout을 할 경우 TalkPlus의 logout 함수를 함께 호출해주셔야 합니다. logout 함수 호출이 누락될 경우 이전에 로그인된 사용자의 Push Notification을 받게될 수 있습니다.

4. Realtime Message

Klat SDK는 앱의 실행주기에 맞춰 Realtime 채널을 구독/구독해제 하고 있습니다.
App이 Foreground에 있을 경우에만 WebSocket을 통하여 메시지를 받고 Background일 경우에 대해서는 FCM을 통해 메시지를 받도록 구현되어 있습니다.
만약 Background에서도 메시지를 받기를 원한다면 Push Notification 항목을 참고하시어 FCM을 연동하셔야 합니다.
이는 Application의 배터리 소모를 최소화 하기 위한 방안입니다.

PreviousWhat's New NextCallback

Last updated 2 months ago

1. iOS SDK 추가

Klat SDK는 Cocoapods 또는 SPM (Swift Package Manager)를 통해서 설치할 수 있습니다.

1) 프로젝트의 Podfile을 열고 아래 내용을 추가합니다.
   pod 'talkplus-ios'

2) pod install 명령어를 사용하여 Klat SDK를 설치합니다.
   pod install --repo-update

1) Xcode에서 아래 메뉴를 클릭합니다.
   Xcode - File -> Add Package Dependencies...

2) 우측 상단 패키지 URL에 아래 저장소 주소를 입력합니다.
   https://github.com/adxcorp/talkplus-ios-release.git

3) 사용하려는 버전을 선택하고 "Add Package" 버튼을 클릭하여 SDK 설치를 완료합니다.

현재 최신 SDK 버전은 1.0.2 입니다.

SPM (Swift Package Manager) 경우, 0.6.3 버전부터 지원됩니다.

SDK 변경 이력

2. Initialize

1) Klat SDK를 사용하려면 다음과 같이 import합니다.

#import <TalkPlus/TalkPlus.h>

import TalkPlus

2) Klat SDK를 사용하기 전 AppDelegate 혹은 Main ViewController 에서 초기화 함수를 호출해줍니다.

[[TalkPlus sharedInstance] initWithAppId:@"YOUR_APP_ID"];

TalkPlus.sharedInstance()?.initWithAppId("YOUR_APP_ID")

3. Login / Logout 프로세스

Klat SDK는 매 실행시마다 login 함수(login:success:failure:)의 호출이 필요합니다.

login이 이루어진 후 logout이 호출되기 전까지 등록된 FCM Token은 유지됩니다. 따라서 오프라인 상태에 들어간 경우에도 Push Notification을 받을 수 있습니다.

사용자가 logout을 할 경우 TalkPlus의 logout 함수를 함께 호출해주셔야 합니다. logout 함수 호출이 누락될 경우 이전에 로그인된 사용자의 Push Notification을 받게될 수 있습니다.

4. Realtime Message

Klat SDK는 앱의 실행주기에 맞춰 Realtime 채널을 구독/구독해제 하고 있습니다.

App이 Foreground에 있을 경우에만 WebSocket을 통하여 메시지를 받고 Background일 경우에 대해서는 FCM을 통해 메시지를 받도록 구현되어 있습니다.

만약 Background에서도 메시지를 받기를 원한다면 Push Notification 항목을 참고하시어 FCM을 연동하셔야 합니다.

이는 Application의 배터리 소모를 최소화 하기 위한 방안입니다.