kakao-partner-android-docs/com.kakao.sdk.user/UserApiClient

UserApiClient

class UserApiClient(userApi: UserApi = ApiFactory.kapiWithOAuth.create(UserApi::class.java), userApiNoLog: UserApi = ApiFactory.kapiWithOAuthNoLog.create(UserApi::class.java), tokenManagerProvider: TokenManagerProvider = TokenManagerProvider.instance)

카카오 로그인 API 클라이언트
Client for the Kakao Login APIs

Constructors

UserApiClient

constructor(userApi: UserApi = ApiFactory.kapiWithOAuth.create(UserApi::class.java), userApiNoLog: UserApi = ApiFactory.kapiWithOAuthNoLog.create(UserApi::class.java), tokenManagerProvider: TokenManagerProvider = TokenManagerProvider.instance)

Types

Companion

object Companion

Functions

accessTokenInfo

fun accessTokenInfo(callback: (tokenInfo: AccessTokenInfo?, error: Throwable?) -> Unit)

액세스 토큰 정보 조회
Access token information

ageAuthInfo

@JvmOverloads

fun UserApiClient.ageAuthInfo(ageLimit: Int? = null, propertyKeys: List<String>? = null, ageCriteria: AgeCriteria? = null, callback: (info: AgeAuthInfo?, error: Throwable?) -> Unit)

연령인증 정보 조회
Check age verification information

createShippingAddress

fun UserApiClient.createShippingAddress(context: Context, callback: (addressId: Long?, error: Throwable?) -> Unit)

배송지 추가
Add Shipping address

getTalkUsers

fun UserApiClient.getTalkUsers(activity: Activity, callback: (users: List<TalkUser>?, error: Throwable?) -> Unit)

AccountManager에 등록된 계정의 사용자 정보 조회(id, 이메일, 닉네임, 프로필 이미지, 통합 약관 동의 여부)
Retrieves information of accounts registered in AccountManager (ID, email, nickname, profile image, wheter the user has agreed to Kakao Comprehensive Terms of Service)

isKakaoTalkLoginAvailable

fun isKakaoTalkLoginAvailable(context: Context): Boolean

카카오톡으로 로그인 가능 여부 확인
Checks whether the Login with Kakao Talk API is available

isSsoAvailable

fun UserApiClient.isSsoAvailable(context: Context): Boolean

SSO 기능 사용 가능 여부, 사용자의 카카오톡 로그인 여부와 무관
Whether SSO feature is available, regardless of user's Kakao Talk login.

loginWithKakao

fun loginWithKakao(context: Context, uiMode: LoginUiMode = LoginUiMode.AUTO, accountParams: AccountLoginParams? = null, nonce: String? = null, channelPublicIds: List<String>? = null, serviceTerms: List<String>? = null, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

카카오톡으로 로그인과 카카오계정으로 로그인 중 하나를 선택할 수 있는 화면 제공
Provides a screen where users can choose between logging in with Kakao Talk or Kakao Account.

loginWithKakaoAccount

@JvmOverloads

fun loginWithKakaoAccount(context: Context, prompts: List<Prompt>? = null, loginHint: String? = null, nonce: String? = null, channelPublicIds: List<String>? = null, serviceTerms: List<String>? = null, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

카카오계정으로 로그인
Login with Kakao Account

loginWithKakaoAccount

@JvmOverloads

fun UserApiClient.loginWithKakaoAccount(context: Context, prompts: List<Prompt>? = null, loginHint: String? = null, nonce: String? = null, channelPublicIds: List<String>? = null, serviceTerms: List<String>? = null, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

카카오계정으로 로그인
Login with Kakao Account

loginWithKakaoTalk

@JvmOverloads

fun loginWithKakaoTalk(context: Context, requestCode: Int = AuthCodeClient.DEFAULT_REQUEST_CODE, nonce: String? = null, channelPublicIds: List<String>? = null, serviceTerms: List<String>? = null, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

카카오톡으로 로그인
Login with Kakao Talk

loginWithNewScopes

fun loginWithNewScopes(context: Context, scopes: List<String>, nonce: String? = null, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

동의항목 추가 동의 요청
Request additional consent

logout

fun logout(callback: (error: Throwable?) -> Unit)

로그아웃
Logout

@JvmOverloads

fun me(properties: List<String>? = null, secureResource: Boolean = true, callback: (user: User?, error: Throwable?) -> Unit)

사용자 정보 조회
Retrieve user information

meForPartner

@JvmOverloads

fun UserApiClient.meForPartner(propertyKeys: List<String>? = null, secureReSource: Boolean = true, callback: (user: PartnerUser?, error: Throwable?) -> Unit)

사용자 정보 조회
Retrieve user information

revokeScopes

fun revokeScopes(scopes: List<String>, callback: (scopeInfo: ScopeInfo?, error: Throwable?) -> Unit)

동의항목 동의 철회
Revoke consent

revokeServiceTerms

fun revokeServiceTerms(tags: List<String>, callback: (userRevokedServiceTerms: UserRevokedServiceTerms?, error: Throwable?) -> Unit)

서비스 약관 동의 철회
Revoke consent for service terms

scopes

fun scopes(scopes: List<String>? = null, callback: (scopeInfo: ScopeInfo?, error: Throwable?) -> Unit)

동의항목 동의 내역 조회
Retrieve consent details

selectShippingAddress

fun selectShippingAddress(context: Context, callback: (addressId: Long?, error: Throwable?) -> Unit)

배송지 선택
Select shipping address

serviceTerms

fun serviceTerms(tags: List<String>? = null, result: String? = null, callback: (userServiceTerms: UserServiceTerms?, error: Throwable?) -> Unit)

서비스 약관 동의 내역 조회
Retrieve consent details for service terms

shippingAddresses

fun shippingAddresses(addressId: Long, callback: (userShippingAddresses: UserShippingAddresses?, error: Throwable?) -> Unit)

@JvmOverloads

fun shippingAddresses(fromUpdatedAt: Date? = null, pageSize: Int? = null, callback: (userShippingAddresses: UserShippingAddresses?, error: Throwable?) -> Unit)

배송지 조회
Retrieve shipping address

signup

fun signup(properties: Map<String, String>? = null, callback: (error: Throwable?) -> Unit)

수동 연결
Manual signup

signupForPartner

@JvmOverloads

fun UserApiClient.signupForPartner(properties: Map<String, String>? = null, callback: (error: Throwable?) -> Unit)

수동 연결
Manual signup

sso

fun UserApiClient.sso(activity: Activity, id: String, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

커스텀 SSO 인증
Custom SSO authentication

fun UserApiClient.sso(activity: Activity, type: SsoLoginType, useUnifiedTerms: Boolean = false, callback: (token: OAuthToken?, error: Throwable?) -> Unit)

SSO 인증
SSO authentication

unlink

fun unlink(callback: (error: Throwable?) -> Unit)

연결 해제
Unlink

updateProfile

fun updateProfile(properties: Map<String, String>, callback: (error: Throwable?) -> Unit)

사용자 프로퍼티 저장
Store user properties

updateShippingAddress

fun UserApiClient.updateShippingAddress(context: Context, addressId: Long, callback: (addressId: Long?, error: Throwable?) -> Unit)

배송지 수정
Update Shipping address

upgradeScopes

@JvmOverloads

fun UserApiClient.upgradeScopes(scopes: List<String>, guardianToken: String? = null, callback: (info: ScopeInfo?, error: Throwable?) -> Unit)

동의항목 동의 처리
Upgrade scopes

verifyAge

fun UserApiClient.verifyAge(context: Context, ageLimit: Int? = null, authLevel: AgeAuthLevel? = null, skipTerms: Boolean? = null, adultsOnly: Boolean? = null, underAge: Boolean? = false, callback: (error: Throwable?) -> Unit)

연령인증 페이지 호출
Request age verification