Reactive
extension Reactive where Base: UserApi
카카오 로그인의 주요 기능을 제공하는 클래스입니다.
이 클래스를 이용하여 카카오톡 간편로그인 또는 카카오계정 로그인 으로 로그인을 수행할 수 있습니다.
카카오톡 간편로그인 예제입니다.
// 로그인 버튼 클릭
if (UserApi.isKakaoTalkLoginAvailable()) {
UserApi.shared.rx.loginWithKakaoTalk()
.subscribe(onNext: { (token) in
print(token)
}, onError: { (error) in
print(error)
})
.disposed(by: self.disposeBag)
}
// AppDelegate
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
if (AuthController.isKakaoTalkLoginUrl(url)) {
if AuthController.handleOpenUrl(url: url, options: options) {
return true
}
}
...
}
카카오계정 로그인 예제입니다.
AuthApi.shared.rx.loginWithKakaoAccount()
.subscribe(onNext: { (token) in
print(token.accessToken)
}, onError: { (error) in
print(error)
})
.disposed(by: self.disposeBag)
user/me를 호출하는 간단한 예제입니다.
UserApi.shared.rx.me()
.subscribe(onSuccess:{ (user) in
print(user)
}, onError: { (error) in
print(error)
})
.disposed(by: <#Your DisposeBag#>)
-
iOS 11 이상에서 제공되는 (SF/ASWeb)AuthenticationSession 을 이용하여 로그인 페이지를 띄우고 쿠키 기반 로그인을 수행합니다. 이미 사파리에에서 로그인하여 카카오계정의 쿠키가 있다면 이를 활용하여 ID/PW 입력 없이 간편하게 로그인할 수 있습니다.
Declaration
Swift
public func loginWithKakaoAccount(prompts: [Prompt]? = nil) -> Observable<OAuthToken>
-
카카오톡 간편로그인을 실행합니다.
Note
UserApi.isKakaoTalkLoginAvailable() 메소드로 실행 가능한 상태인지 확인이 필요합니다. 카카오톡을 실행할 수 없을 경우 loginWithKakaoAccount() 메소드로 웹 로그인을 시도할 수 있습니다.Declaration
Swift
public func loginWithKakaoTalk(channelPublicIds: [String]? = nil, serviceTerms: [String]? = nil) -> Observable<OAuthToken>
-
사용자로부터 카카오가 보유중인 사용자 정보 제공에 대한 동의를 받습니다.
카카오로부터 사용자의 정보를 제공 받거나 카카오서비스 접근권한이 필요한 경우, 사용자로부터 해당 정보 제공에 대한 동의를 받지 않았다면 이 메소드를 사용하여 추가 항목 동의를 받아야 합니다. 필요한 동의항목과 매칭되는 scope id를 배열에 담아 파라미터로 전달해야 합니다. 동의항목과 scope id는 카카오 디벨로퍼스의 [내 애플리케이션] > [제품 설정] > [카카오 로그인] > [동의항목]에서 확인할 수 있습니다.
사용자 동의 획득 시나리오
간편로그인 또는 웹 로그인을 수행하면 최초 로그인 시 카카오 디벨로퍼스에 설정된 동의항목 설정에 따라 사용자의 동의를 받습니다. 동의항목을 설정해도 상황에 따라 동의를 받지 못할 수 있습니다. 대표적인 케이스는 아래와 같습니다.
- 선택 동의 로 설정된 동의항목이 최초 로그인시 선택받지 못한 경우
- 필수 동의 로 설정하였지만 해당 정보가 로그인 시점에 존재하지 않아 카카오에서 동의항목을 보여주지 못한 경우
- 사용자가 해당 동의항목이 설정되기 이전에 로그인한 경우
이외에도 다양한 여건에 따라 동의받지 못한 항목이 발생할 수 있습니다.
추가 항목 동의 받기 시 주의사항
선택 동의 으로 설정된 동의항목에 대한 추가 항목 동의 받기는, 반드시 사용자가 동의를 거부하더라도 서비스 이용이 지장이 없는 시나리오에서 요청해야 합니다.
Declaration
Swift
public func loginWithKakaoAccount(scopes: [String]) -> Observable<OAuthToken>
-
앱 연결 상태가 PREREGISTER 상태의 사용자에 대하여 앱 연결 요청을 합니다. 자동연결 설정을 비활성화한 앱에서 사용합니다. 요청에 성공하면 사용자 아이디가 반환됩니다.
Declaration
Swift
public func signup() -> Single<Int64?>
-
사용자에 대한 다양한 정보를 얻을 수 있습니다.
Seealso
User
Declaration
Swift
public func me(propertyKeys: [String]? = nil, secureResource: Bool = true) -> Single<User>
-
User 클래스에서 제공되고 있는 사용자의 부가정보를 신규저장 및 수정할 수 있습니다.
저장 가능한 키 이름은 개발자 사이트의 [내 애플리케이션] > [제품 설정] > [카카오 로그인] > [사용자 프로퍼티] 메뉴에서 확인하실 수 있습니다. 앱 연결 시 기본 저장되는 nickanme, profile_image, thumbnail_image 값도 덮어쓰기 가능하며 새로운 컬럼을 추가하면 해당 키 이름으로 값을 저장할 수 있습니다.
Seealso
User.properties
Declaration
Swift
public func updateProfile(properties: [String : Any]) -> Completable
-
현재 토큰의 기본적인 정보를 조회합니다. me()에서 제공되는 다양한 사용자 정보 없이 가볍게 토큰의 유효성을 체크하는 용도로 사용하는 경우 추천합니다.
Seealso
AccessTokenInfo
Declaration
Swift
public func accessTokenInfo() -> Single<AccessTokenInfo>
-
토큰을 강제로 만료시킵니다. 같은 사용자가 여러개의 토큰을 발급 받은 경우 로그아웃 요청에 사용된 토큰만 만료됩니다.
Declaration
Swift
public func logout() -> Completable
-
카카오 플랫폼 서비스와 앱 연결을 해제합니다.
Declaration
Swift
public func unlink() -> Completable
-
앱에 가입한 사용자의 배송지 정보를 얻을 수 있습니다.
Seealso
UserShippingAddresses
Declaration
Swift
public func shippingAddresses(fromUpdatedAt: Int? = nil, pageSize: Int? = nil) -> Single<UserShippingAddresses>
-
앱에 가입한 사용자의 배송지 정보를 얻을 수 있습니다.
Seealso
UserShippingAddresses
Declaration
Swift
public func shippingAddresses(addressId: Int64) -> Single<UserShippingAddresses>
-
사용자가 카카오 간편가입을 통해 동의한 서비스 약관 내역을 반환합니다.
Seealso
UserServiceTerms
Declaration
Swift
public func serviceTerms() -> Single<UserServiceTerms>