UserAccount (Kakao Android SDK

java.lang.Object
- com.kakao.usermgmt.response.model.UserAccount

```
public class UserAccount
extends Object
```
Class for Kakao account user data, meaning these data are account-scoped, not app-scoped.

Constructor Summary

Constructors
Constructor and Description

UserAccount(com.kakao.network.response.ResponseBody body)

Constructors
Constructor and Description
`UserAccount(com.kakao.network.response.ResponseBody body)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`OptionalBoolean`	`ageRangeNeedsAgreement()` 연령대 제공에 대한 사용자 동의 필요 여부
`OptionalBoolean`	`birthdayNeedsAgreement()` 생일 제공에 대한 사용자 동의 필요 여부
`OptionalBoolean`	`birthyearNeedsAgreement()` 생년 제공에 대한 사용자 동의 필요 여부
`String`	`ciAuthenticatedAt()` 사용자가 ci를 획득한 시간.
`OptionalBoolean`	`ciNeedsAgreement()` CI 제공에 대한 사용자 동의 필요 여부
`OptionalBoolean`	`emailNeedsAgreement()` 이메일 제공에 대한 사용자 동의 필요 여부
`OptionalBoolean`	`genderNeedsAgreement()` 성별 제공에 대한 사용자 동의 필요 여부
`AgeRange`	`getAgeRange()` Returns user's age range.
`String`	`getBirthday()` Returns user's birthday in mmdd format (0115, 0427, etc).
`BirthdayType`	`getBirthdayType()` 생일의 양력,음력
`String`	`getBirthyear()` 유저의 출생 연도를 반환한다.
`String`	`getCI()` 유저의 CI 값
`String`	`getDisplayId()` Returns user's display id.
`String`	`getEmail()` Returns email of user's Kakao account.
`Gender`	`getGender()` Return user's gender.
`String`	`getLegalBirthDate()` 법정 생년월일.
`Gender`	`getLegalGender()` 법정 성별.
`String`	`getLegalName()` 2차 본인인증으로 수집된 사용자의 실명.
`String`	`getPhoneNumber()` Returns phone number of user's Kakao account.
`Profile`	`getProfile()` 카카오계정의 프로필
`org.json.JSONObject`	`getResponse()` Returns a raw json API response.
`OptionalBoolean`	`isEmailValid()`
`OptionalBoolean`	`isEmailVerified()`
`OptionalBoolean`	`isKakaoTalkUser()` 카카오톡 가입 여부
`boolean`	`isKakaotalkUserNeedsAgreement()`
`OptionalBoolean`	`isKorean()` 내국인 여부.
`OptionalBoolean`	`isKoreanNeedsAgreement()` 사용자의 동의를 받으면 본인인증된 내국인 여부(is_korean)를 가지고 갈 수 있는지 여부.
`OptionalBoolean`	`legalBirthDateNeedsAgreement()` 사용자 동의를 받으면 본인인증된 생년월일(legal_birth_date)를 가지고 갈 수 있는지 여부.
`OptionalBoolean`	`legalGenderNeedsAgreement()` 사용자 동의를 받으면 본인인증된 성별(legal_gender)를 가지고 갈 수 있는지 여부.
`OptionalBoolean`	`legalNameNeedsAgreement()` 사용자 동의를 받으면 본인인증된 실명(legal_name)을 가지고 갈 수 있는지 여부.
`boolean`	`needsScopeIsKakaotalkUser()` Deprecated.
`OptionalBoolean`	`phoneNumberNeedsAgreement()` 전화번호 제공에 대한 사용자 동의 필요 여부
`OptionalBoolean`	`profileNeedsAgreement()` 프로필 제공에 대한 사용자 동의 필요 여부
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserAccount
```
public UserAccount(com.kakao.network.response.ResponseBody body)
```
- Method Detail
  - ageRangeNeedsAgreement
```
public OptionalBoolean ageRangeNeedsAgreement()
```
    연령대 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 age_range 입니다. 이미 연령대가 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's age range can be provided after scope update (age_range)
  - birthdayNeedsAgreement
```
public OptionalBoolean birthdayNeedsAgreement()
```
    생일 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 birthday 입니다. 이미 전화번호가 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's birthday can be provided after scope update (birthday)
  - birthyearNeedsAgreement
```
public OptionalBoolean birthyearNeedsAgreement()
```
    생년 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 birthyear 입니다. 이미 전화번호가 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's birthyear can be provided after scope update (birthyear)
  - ciAuthenticatedAt
```
public String ciAuthenticatedAt()
```
    사용자가 ci를 획득한 시간. 카카오계정에 등록된 사용자의 ci 획득시간이 제공됩니다.
  - ciNeedsAgreement
```
public OptionalBoolean ciNeedsAgreement()
```
    CI 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 account_ci 입니다. 이미 CI가 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's ci can be provided after scope update (account_ci)
  - emailNeedsAgreement
```
public OptionalBoolean emailNeedsAgreement()
```
    이메일 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 account_email 입니다. 이미 이메일이 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's email can be provided after scope update (account_email)
  - genderNeedsAgreement
```
public OptionalBoolean genderNeedsAgreement()
```
    성별 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 gender 입니다. 이미 전화번호가 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's gender can be provided after scope update (gender)
  - getAgeRange
```
public AgeRange getAgeRange()
```
    Returns user's age range. This getter returns null if: - when the account has no age range info - when the user did not agree to provide age range info to this app
    
    Returns:
    
    AgeRange enum, null if not included in the API response.
  - getBirthday
```
public String getBirthday()
```
    Returns user's birthday in mmdd format (0115, 0427, etc).
    
    Returns:
    
    birthday in mmdd format, null if not included in the API response.
  - getBirthdayType
```
public BirthdayType getBirthdayType()
```
    생일의 양력,음력
  - getBirthyear
```
public String getBirthyear()
```
    유저의 출생 연도를 반환한다. (ex. 1990)
    
    Returns:
    
    user's birthyear
  - getCI
```
public String getCI()
```
    유저의 CI 값
    
    Returns:
    
    유저가 본인 인증후 받은 CI 값
  - getDisplayId
```
public String getDisplayId()
```
    Returns user's display id. This will be either email address or phone number.
    
    Returns:
    
    displayId
  - getEmail
```
public String getEmail()
```
    Returns email of user's Kakao account. This method returns null under following cases: - when user does not have email (she/he registered with phone number) - when user did not agree to provide email to this service
    
    Returns:
    
    email
  - getGender
```
@Nullable
public Gender getGender()
```
    Return user's gender.
    
    Returns:
    
    Gender enum, null if not included in the API response.
  - getLegalBirthDate
```
public String getLegalBirthDate()
```
    법정 생년월일. 2차 본인인증으로 수집된 사용자의 생년월일. yyyyMMDD 형식.
  - getLegalGender
```
public Gender getLegalGender()
```
    법정 성별. 2차 본인인증으로 수집된 사용자의 성별. female(여)/male(남)
  - getLegalName
```
public String getLegalName()
```
    2차 본인인증으로 수집된 사용자의 실명.
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Returns phone number of user's Kakao account. This method returns null under the following cases: - when the account has no phone number - when user did not agree to provide phone number
    
    Returns:
    
    phoneNumber
  - getProfile
```
public Profile getProfile()
```
    카카오계정의 프로필
    
    Returns:
    
    Kakao account's profile
  - getResponse
```
public org.json.JSONObject getResponse()
```
    Returns a raw json API response. If there is any data not defined as field in this class, you can query with appropriate keys.
    
    Returns:
    
    raw API response
  - isEmailValid
```
public OptionalBoolean isEmailValid()
```
  - isEmailVerified
```
public OptionalBoolean isEmailVerified()
```
    Returns:
    
    OptionalBoolean.TRUE if email is verified, OptionalBoolean.FALSE if not verified, OptionalBoolean.NONE if this info cannot be provided.
  - isKakaoTalkUser
```
public OptionalBoolean isKakaoTalkUser()
```
    카카오톡 가입 여부
    제휴를 통해 권한이 부여된 특정 앱에서만 획득할 수 있습니다. 제휴되어 있지 않은 경우 OptionalBoolean.NONE 이 반환됩니다. 카카오톡 카카오계정 설정에 연결되어 있는 경우 OptionalBoolean.TRUE 가 반환됩니다. 사용자 동의가 필요한 경우 OptionalBoolean.NONE 이 반환되며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 is_kakaotalk_user 입니다.
  - isKakaotalkUserNeedsAgreement
```
public boolean isKakaotalkUserNeedsAgreement()
```
  - isKorean
```
public OptionalBoolean isKorean()
```
    내국인 여부. 2차 본인인증으로 수집된 내/외국인 정보. true(내국인)
  - isKoreanNeedsAgreement
```
public OptionalBoolean isKoreanNeedsAgreement()
```
    사용자의 동의를 받으면 본인인증된 내국인 여부(is_korean)를 가지고 갈 수 있는지 여부.
  - legalBirthDateNeedsAgreement
```
public OptionalBoolean legalBirthDateNeedsAgreement()
```
    사용자 동의를 받으면 본인인증된 생년월일(legal_birth_date)를 가지고 갈 수 있는지 여부.
  - legalGenderNeedsAgreement
```
public OptionalBoolean legalGenderNeedsAgreement()
```
    사용자 동의를 받으면 본인인증된 성별(legal_gender)를 가지고 갈 수 있는지 여부.
  - legalNameNeedsAgreement
```
public OptionalBoolean legalNameNeedsAgreement()
```
    사용자 동의를 받으면 본인인증된 실명(legal_name)을 가지고 갈 수 있는지 여부.
  - needsScopeIsKakaotalkUser
```
@Deprecated
public boolean needsScopeIsKakaotalkUser()
```
    Deprecated.
  - phoneNumberNeedsAgreement
```
public OptionalBoolean phoneNumberNeedsAgreement()
```
    전화번호 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 phone_number 입니다. 이미 전화번호가 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's phone number can be provided after scope update (phone_number)
  - profileNeedsAgreement
```
public OptionalBoolean profileNeedsAgreement()
```
    프로필 제공에 대한 사용자 동의 필요 여부
    OptionalBoolean.TRUE 인 경우 새로운 동의 요청이 가능한 상태이며 Session.updateScopes(Activity, List, AccessTokenCallback) 메소드를 이용하여 동의를 받을 수 있습니다. 파라미터로 전달할 scope ID 는 profile 입니다. 이미 프로필이 제공되고 있는 경우에는 OptionalBoolean.FALSE 가 반환됩니다.
    check if user's profile can be provided after scope update (profile)
  - toString
```
@NonNull
public String toString()
```
    Overrides:
    
    toString in class Object

Class UserAccount

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserAccount

Method Detail

ageRangeNeedsAgreement

birthdayNeedsAgreement

birthyearNeedsAgreement

ciAuthenticatedAt

ciNeedsAgreement

emailNeedsAgreement

genderNeedsAgreement

getAgeRange

getBirthday

getBirthdayType

getBirthyear

getCI

getDisplayId

getEmail

getGender

getLegalBirthDate

getLegalGender

getLegalName

getPhoneNumber

getProfile

getResponse

isEmailValid

isEmailVerified

isKakaoTalkUser

isKakaotalkUserNeedsAgreement

isKorean

isKoreanNeedsAgreement

legalBirthDateNeedsAgreement

legalGenderNeedsAgreement

legalNameNeedsAgreement

needsScopeIsKakaotalkUser

phoneNumberNeedsAgreement

profileNeedsAgreement

toString