KOUserMeAccount Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in KOUserMe.h

Overview

카카오계정 정보를 나타내는 클래스

이 클래스에서 제공하는 카카오계정의 모든 개인정보는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
개인정보 필드의 값이 없으면 해당 필드와 매칭되는 {property}NeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
{property}NeedsAgreement 값이 true인 경우 새로운 동의 요청이 가능한 상태이며 [KOSession updateScopes:completionHandler:] 메소드를 이용하여 동의를 받을 수 있습니다. 동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 해당 값이 반환될 것입니다.
{property}NeedsAgreement 값이 false인 경우 사용자의 계정에 해당 정보가 없어서 값을 얻을 수 없음을 의미합니다.

  profile

카카오계정에 등록한 프로필 정보

@property (readonly, nullable) KOUserMeProfile *profile

Discussion

프로필 정보는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
프로필이 nil이면 profileNeedsAgreement 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 프로필 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  profileNeedsAgreement

카카오계정 프로필 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL profileNeedsAgreement

Discussion

profile이 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 프로필 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
프로필 동의항목에 대한 scope ID는 “profile"입니다.

See Also

Declared In

KOUserMe.h

  email

카카오계정에 등록한 이메일 정보

@property (readonly, nullable) NSString *email

Discussion

이메일은 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
이메일이 nil이면 emailNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 이메일 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  isEmailVerified

카카오계정에 이메일 등록 시 이메일 인증을 받았는지 여부

@property (readonly) KOOptionalBoolean isEmailVerified

See Also

Declared In

KOUserMe.h

  emailNeedsAgreement

이메일 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL emailNeedsAgreement

Discussion

email 이 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 이메일 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
이메일 동의항목에 대한 scope ID는 “account_email"입니다.

See Also

Declared In

KOUserMe.h

  isKakaotalkUser

카카오톡 서비스 가입 여부

@property (readonly) KOOptionalBoolean isKakaotalkUser

Discussion

제휴를 통해 권한이 부여된 특정 앱에서만 획득할 수 있습니다. 제휴되어 있지 않은 경우 null이 반환됩니다.
카카오톡 카카오계정 설정에 연결되어 있는 카카오계정은 true가 반환됩니다.
사용자에게 동의를 받지 않았을 경우 null이 반환되며 [KOSession updateScopes:completionHandler:] 메소드를 이용하여 사용자로부터 카카오톡 가입 여부에 대한 동의를 받을 수 있습니다.
카카오톡 서비스 가입 여부 scope ID는 “is_kakaotalk_user"입니다.

Declared In

KOUserMe.h

  phoneNumber

카카오톡에서 인증한 전화번호

@property (readonly, nullable) NSString *phoneNumber

Discussion

제휴를 통해 권한이 부여된 특정 앱에서만 획득할 수 있습니다. 카카오톡에 연결되어 있지 않은 카카오계정은 전화번호가 존재하지 않습니다.
phoneNumber 는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
phoneNumber 가 nil이면 phoneNumberNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 phoneNumber 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  phoneNumberNeedsAgreement

phoneNumber 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL phoneNumberNeedsAgreement

Discussion

phoneNumber 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 전화번호 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
전화번호 동의항목에 대한 scope ID는 “phone_number"입니다.

See Also

Declared In

KOUserMe.h

  displayID

카카오계정의 대표 정보. 이메일 또는 전화번호

@property (readonly, nullable) NSString *displayID

Discussion

제휴를 통해 권한이 부여된 특정 앱에서만 획득할 수 있습니다. 계정 상태에 이상이 생긴 경우 텍스트 일부가 마스킹 처리되어 반환됩니다.

See Also

Declared In

KOUserMe.h

  ageRange

사용자의 연령대 정보

@property (readonly) KOUserAgeRange ageRange

Discussion

카카오계정에 등록된 사용자의 생일 정보를 기반으로 제공됩니다.
ageRange 는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
ageRange 가 nil이면 ageRangeNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 ageRange 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  ageRangeNeedsAgreement

ageRange 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL ageRangeNeedsAgreement

Discussion

ageRange 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 연령대 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
연령대 동의항목에 대한 scope ID는 “age_range"입니다.

See Also

Declared In

KOUserMe.h

  birthyear

사용자의 출생 연도

@property (readonly, nullable) NSString *birthyear

Discussion

카카오계정에 등록된 사용자의 출생 연도 정보를 기반으로 제공됩니다. (yyyy형식)
birthyear 는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
birthyear 가 nil이면 birthyearNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 birthyear 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  birthyearNeedsAgreement

birthyear 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL birthyearNeedsAgreement

Discussion

birthyear 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 출생 연도 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
출생 연도 동의항목에 대한 scope ID는 “birthyear"입니다.

See Also

Declared In

KOUserMe.h

  birthday

사용자의 생일

@property (readonly, nullable) NSString *birthday

Discussion

카카오계정에 등록된 사용자의 생일 정보를 기반으로 제공됩니다. (MMDD형식)
birthday 는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
birthday 가 nil이면 birthdayNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 birthday 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  birthdayType

생일의 양력,음력

@property (readonly) KOUserBirthdayType birthdayType

See Also

Declared In

KOUserMe.h

  birthdayNeedsAgreement

birthday 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL birthdayNeedsAgreement

Discussion

birthday 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 생일 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
생일 동의항목에 대한 scope ID는 “birthday"입니다.

See Also

Declared In

KOUserMe.h

  gender

사용자의 성별

@property (readonly) KOUserGender gender

Discussion

카카오계정에 등록된 사용자의 성별 정보가 제공됩니다.
gender는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
gender가 nil이면 genderNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 gender 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  genderNeedsAgreement

gender 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL genderNeedsAgreement

Discussion

gender 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 성별 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
성별 동의항목에 대한 scope ID는 “gender"입니다.

See Also

Declared In

KOUserMe.h

  ci

사용자 연계정보

@property (readonly, nullable) NSString *ci

Discussion

@property ci

카카오계정에 등록된 사용자의 ci가 제공됩니다. (base64형식)
ci는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
ci가 nil이면 ciNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 ci 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  ciNeedsAgreement

ci 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL ciNeedsAgreement

Discussion

ci 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 ci 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
ci 동의항목에 대한 scope ID는 “account_ci"입니다.

See Also

Declared In

KOUserMe.h

  ciAuthenticatedAt

사용자가 ci를 획득한 시간.

@property (readonly, nullable) NSDate *ciAuthenticatedAt

Discussion

카카오계정에 등록된 사용자의 ci획득시간이 제공됩니다.

See Also

Declared In

KOUserMe.h

  legalName

실명

@property (readonly, nullable) NSString *legalName

Discussion

카카오계정에 등록된 사용자의 실명이 제공됩니다.
이 값은 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
값이 nil이면 legalNameNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  legalNameNeedsAgreement

legalName 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL legalNameNeedsAgreement

Discussion

legalName 이 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 실명 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
실명 동의항목에 대한 scope ID는 “legal_name"입니다.

See Also

Declared In

KOUserMe.h

  legalBirthDate

법정생년월일

@property (readonly, nullable) NSString *legalBirthDate

Discussion

카카오계정에 등록된 사용자의 법정생년월일 정보가 제공됩니다.
이 값은 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
값이 nil이면 legalBirthDateNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  legalBirthDateNeedsAgreement

legalBirthDate 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL legalBirthDateNeedsAgreement

Discussion

legalBirthDate 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 법정생년월일 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
법정생년월일 동의항목에 대한 scope ID는 “legal_birth_date"입니다.

See Also

Declared In

KOUserMe.h

  legalGender

법정성별

@property (readonly) KOUserGender legalGender

Discussion

카카오계정에 등록된 사용자의 법정성별 정보가 제공됩니다.
이 값은 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
값이 nil이면 legalGenderNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  legalGenderNeedsAgreement

legalGender 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL legalGenderNeedsAgreement

Discussion

legalGender 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 법정성별 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
법정성별 동의항목에 대한 scope ID는 “legal_gender"입니다.

See Also

Declared In

KOUserMe.h

  isKorean

내국인 여부

@property (readonly) KOOptionalBoolean isKorean

Discussion

카카오계정에 등록된 사용자의 내국인 여부 정보가 제공됩니다.
이 값은 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
값이 nil이면 isKoreanNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 값이 반환됩니다.

See Also

Declared In

KOUserMe.h

  isKoreanNeedsAgreement

isKorean 제공에 대한 사용자 동의 필요 여부

@property (readonly) BOOL isKoreanNeedsAgreement

Discussion

isKorean 가 nil로 내려왔는데 정보를 제공받기 원한다면 이 값을 확인해야 합니다.
true이면 [KOSession updateScopes:completionHandler:] 메소드로 사용자 동의를 받고 [KOSessionTask userMeTaskWithCompletion:]를 재요청하여 내국인 여부 정보를 받을 수 있습니다. 개발자사이트 동의항목 설정에서 수집 기능이 활성화된 경우 사용자로부터 해당 정보를 수집합니다.
내국인 여부 동의항목에 대한 scope ID는 “is_korean"입니다.

See Also

Declared In

KOUserMe.h