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

UserApiClient

class UserApiClient

카카오 Open API의 사용자관리 API 호출을 담당하는 클라이언트.

Since
2.0.0

Constructors

<init>

카카오 Open API의 사용자관리 API 호출을 담당하는 클라이언트.

UserApiClient(userApi: UserApi = ApiFactory.kapiWithOAuth.create(UserApi::class.java))

Functions

accessTokenInfo

현재 토큰의 기본적인 정보를 조회합니다.

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

logout

토큰을 강제로 만료시킵니다. 같은 사용자가 여러개의 토큰을 발급 받은 경우 로그아웃 요청에 사용된 토큰만 만료됩니다.

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

me

사용자에 대한 다양한 정보를 얻을 수 있습니다.

fun me(secureReSource: Boolean = true, callback: (user: User?, error: Throwable?) -> Unit): Unit

serviceTerms

사용자가 카카오 간편가입을 통해 동의한 서비스 약관 내역을 반환합니다.

fun serviceTerms(callback: (userServiceTerms: UserServiceTerms?, error: Throwable?) -> Unit): Unit

shippingAddresses

앱에 가입한 사용자의 배송지 정보를 얻어갑니다.

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

unlink

카카오 플랫폼 서비스와 앱 연결을 해제합니다.

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

updateProfile

User 클래스에서 제공되고 있는 사용자의 부가정보를 신규저장 및 수정할 수 있습니다.

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

Companion Object Properties

instance

간편한 API 호출을 위해 기본 제공되는 singleton 객체

val instance: UserApiClient

Extension Functions

meForPartner

파트너용 /v2/user/me API 를 호출합니다. 사용자에 대한 다양한 정보를 얻을 수 있습니다.

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

signup

앱 연결 상태가 PREREGISTER 상태의 사용자에 대하여 앱 연결 요청을 합니다. 자동연결 설정을 비활성화한 앱에서 사용합니다.

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

Companion Object Extension Properties

rx

Reactive-X 를 위한 UserApiClient singleton 객체

val UserApiClient.Companion.rx: RxUserApiClient