KOUserMe Class Reference

Inherits from NSObject
Conforms to KOTalkMessageSending
NSCopying
Declared in KOUserMe.h

Overview

사용자 정보를 나타내는 최상위 클래스. ID, 카카오계정 정보, 프로퍼티 등으로 구성됩니다.

  hasSignedUp

현재 로그인한 사용자가 앱에 연결[KOSessionTask signupTaskWithProperties:completionHandler:]되어 있는지 여부

@property (readonly) KOOptionalBoolean hasSignedUp

Discussion

사용자관리 설정에서 자동연결 옵션을 off한 앱에서만 사용되는 값입니다. 자동연결의 기본값은 on이며 이 경우 값이 null로 반환되고 이미 연결되어 있음을 의미합니다.

Declared In

KOUserMe.h

  ID

사용자의 고유 아이디

@property (readonly, nullable) NSString *ID

Discussion

사용자 ID는 최초 로그인에 성공하면 발급됩니다.
사용자 아이디 고정이 활성화되지 않은 앱이 연결해제[KOSessionTask unlinkTaskWithCompletionHandler:]를 실행한 후 다시 로그인하면 새로운 값으로 재발급됩니다.
사용자 아이디 고정이 활성화된 앱은 동일 앱, 동일 카카오계정에 대하여 항상 같은 아이디가 부여됩니다.

Declared In

KOUserMe.h

  account

로그인한 카카오계정 정보. 이메일 등

@property (readonly, nullable) KOUserMeAccount *account

See Also

Declared In

KOUserMe.h

  synchedAt

카카오싱크 간편가입을 통해 카카오 로그인 한 시각

@property (readonly, nullable) NSDate *synchedAt

Declared In

KOUserMe.h

  connectedAt

해당 서비스에 연결된 시각

@property (readonly, nullable) NSDate *connectedAt

Declared In

KOUserMe.h

  nickname

사용자의 닉네임 (Deprecated: 실시간 카카오계정 프로필 정보를 얻을 수 있는 account.profile 을 활용해보세요.)

@property (readonly, nullable) DEPRECATED_MSG_ATTRIBUTE ( "실시간 카카오계정 프로필 정보를 얻을 수 있는 me.account.profile 속성을 활용해보세요. 자세한 사용법은 KOUserMeProfile 클래스 설명을 참고하시기 바랍니다." ) NSString *nickname

Discussion

properties에서 “nickname” 값을 가져옵니다. 초기 값은 카카오계정 프로필에 있는 값으로 저장됩니다. 카카오계정에 닉네임이 없을 경우 개발자사이트의 사용자 관리 > 앱 연동 설정 에 따라 카카오톡 또는 카카오스토리에 설정된 닉네임으로 저장되며 이후 해당 프로필 정보와 동기화되지 않습니다. 카카오톡이나 카카오스토리의 최신 프로필 정보를 가져오려면 [KOSessionTask talkProfileTaskWithCompletionHandler:], [KOSessionTask storyProfileTaskWithCompletionHandler:] 를 이용해주세요.

Declared In

KOUserMe.h

  profileImageURL

원본 프로필 이미지 URL (Deprecated: 실시간 카카오계정 프로필 정보를 얻을 수 있는 account.profile 을 활용해보세요.)

@property (readonly, nullable) DEPRECATED_MSG_ATTRIBUTE ( "실시간 카카오계정 프로필 정보를 얻을 수 있는 me.account.profile 속성을 활용해보세요. 자세한 사용법은 KOUserMeProfile 클래스 설명을 참고하시기 바랍니다." ) NSURL *profileImageURL

Discussion

properties에 있는 “profile_image” 값을 이용하여 생성된 NSURL 인스턴스를 제공합니다. 초기 값은 카카오계정 프로필에 있는 값으로 저장됩니다. 카카오계정에 프로필 이미지가 없을 경우 개발자사이트의 사용자 관리 > 앱 연동 설정 에 따라 카카오톡 또는 카카오스토리에 설정된 프로필 이미지 URL로 저장되며 이후 해당 프로필 정보와 동기화되지 않습니다. 카카오톡이나 카카오스토리의 최신 프로필 정보를 가져오려면 [KOSessionTask talkProfileTaskWithCompletionHandler:], [KOSessionTask storyProfileTaskWithCompletionHandler:] 를 이용해주세요.

Declared In

KOUserMe.h

  thumbnailImageURL

썸네일 이미지 URL (Deprecated: 실시간 카카오계정 프로필 정보를 얻을 수 있는 account.profile 을 활용해보세요.)

@property (readonly, nullable) DEPRECATED_MSG_ATTRIBUTE ( "실시간 카카오계정 프로필 정보를 얻을 수 있는 me.account.profile 속성을 활용해보세요. 자세한 사용법은 KOUserMeProfile 클래스 설명을 참고하시기 바랍니다." ) NSURL *thumbnailImageURL

Discussion

properties에 있는 “thumbnail_image” 값을 이용하여 생성된 NSURL 인스턴스를 제공합니다. 초기 값은 카카오계정 프로필에 있는 값으로 저장됩니다. 카카오계정에 프로필 이미지가 없을 경우 개발자사이트의 사용자 관리 > 앱 연동 설정 에 따라 카카오톡 또는 카카오스토리에 설정된 프로필 이미지 URL로 저장되며 이후 해당 프로필 정보와 동기화되지 않습니다. 카카오톡이나 카카오스토리의 최신 프로필 정보를 가져오려면 [KOSessionTask talkProfileTaskWithCompletionHandler:], [KOSessionTask storyProfileTaskWithCompletionHandler:] 를 이용해주세요.

Declared In

KOUserMe.h

  properties

앱 별로 제공되는 사용자 부가정보 데이터베이스

@property (readonly, nullable) NSDictionary<NSString*NSString*> *properties

Discussion

사용자에 대해 추가 정보를 저장할 수 있도록 데이터베이스를 제공합니다.

이 데이터베이스를 통해 사용자의 프로필 정보를 제공 받을 수 있습니다. 로그인한 사용자의 카카오계정 프로필에 있는 닉네임과 프로필 이미지 정보를 앱 연결 시점에 복사하여 초기값으로 제공되며 이후 해당 카카오계정 프로필에 변경이 발생한 경우 변경된 정보와 동기화되지 않습니다. 실시간 프로필 정보를 원하는 경우 account.profile 속성으로 닉네임 및 프로필 이미지를 조회하시기 바랍니다.
기본 제공되는 사용자 프로필 정보의 키 이름은 아래와 같습니다.
1. nickname : 카카오계정에 설정된 닉네임
2. profile_image : 프로필 이미지 URL 문자열
3. thumbnail_image : 썸네일 사이즈의 프로필 이미지 URL 문자열

프로필 정보 외에 다른 정보를 추가 저장하거나 기본 제공되는 정보를 수정하고 싶은 경우 KOSessionTask의 profileUpdateTask 메소드를 사용할 수 있습니다.

Declared In

KOUserMe.h

  forPartner

제휴를 통해 권한이 부여된 특정 앱에서 사용

@property (readonly, nullable) NSDictionary<NSString*id> *forPartner

Declared In

KOUserMe.h

  groupToken

앱이 그룹에 속해 있는 경우 그룹 내 사용자 식별 토큰

@property (readonly, nullable) NSString *groupToken

Discussion

앱의 그룹정보가 변경될 경우 토큰 값도 변경됩니다. 제휴를 통해 권한이 부여된 특정 앱에만 제공됩니다.

Declared In

KOUserMe.h