KOUserMe Class Reference

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

Overview

@class KOUserMe

Other Methods

  hasSignedUp

현재 로그인한 사용자가 앱에 연결(signup)되어 있는지 여부

@property (readonly) KOOptionalBoolean hasSignedUp

Discussion

@property hasSignedUp

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

Declared In

KOUserMe.h

  ID

사용자의 고유 아이디

@property (readonly, nullable) NSString *ID

Discussion

@property ID

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

Declared In

KOUserMe.h

  account

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

@property (readonly, nullable) KOUserMeAccount *account

Discussion

@property account

Declared In

KOUserMe.h

  nickname

사용자의 닉네임

@property (readonly, nullable) NSString *nickname

Discussion

@property nickname

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

Declared In

KOUserMe.h

  profileImageURL

원본 프로필 이미지 URL

@property (readonly, nullable) NSURL *profileImageURL

Discussion

@property profileImageURL

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

Declared In

KOUserMe.h

  thumbnailImageURL

썸네일 이미지 URL

@property (readonly, nullable) NSURL *thumbnailImageURL

Discussion

@property thumbnailImageURL

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

Declared In

KOUserMe.h

  properties

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

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

Discussion

@property properties

사용자에 대해 추가 정보를 저장할 수 있도록 데이터베이스를 제공합니다.
로그인한 사용자의 카카오계정 프로필에 있는 닉네임과 프로필 이미지 정보를 앱 연결 시점에 복사하여 초기값으로 제공되며 이후 해당 프로필 정보와 동기화되지 않습니다.
해당 카카오계정에 프로필 정보가 없을 경우 개발자사이트의 사용자 관리 > 앱 연동 설정에 따라 카카오톡 또는 카카오스토리에 있는 정보가 제공됩니다. 1. nickname : 카카오계정에 설정된 닉네임
2. profile_image : 프로필 이미지 URL 문자열
3. thumbnail_image : 썸네일 사이즈의 프로필 이미지 URL 문자열

Declared In

KOUserMe.h

  forPartner

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

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

Discussion

@property forPartner

Declared In

KOUserMe.h

  groupToken

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

@property (readonly, nullable) NSString *groupToken

Discussion

@property groupToken

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

Declared In

KOUserMe.h

Other Methods

– sendMemoWithTemplate:completionHandler:

기본 제공되는 템플릿을 이용하여, 카카오톡의 “나와의 채팅방"으로 메시지를 전송합니다. 모든 앱에서 호출 가능합니다.

- (KOSessionTask *)sendMemoWithTemplate:(KMTTemplate *)template completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

templateObj

전송할 메시지 템플릿 오브젝트. KMTTemplate 클래스를 직접 생성해서 사용할 수 없고 원하는 템플릿에 맞는 적절한 하위 클래스로 오브젝트를 생성해야 함.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Discussion

KMTTemplate 클래스는 KakaoMessageTemplate.framework에 포함되어 있습니다. 이 메소드를 사용하기 위해서는 Build Phases > Link Binary With Libraries 설정에 KakaoMessageTemplate.framework를 추가해야 합니다.

Declared In

KOTalkMessageSending.h

– sendMemoWithURL:completionHandler:

지정된 URL을 스크랩하여, 카카오톡의 “나와의 채팅방"으로 메시지를 전송합니다. 모든 앱에서 호출 가능합니다.

- (KOSessionTask *)sendMemoWithURL:(NSURL *)URL completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

URL

스크랩할 URL. 개발자사이트 앱 설정에 등록된 도메인만 허용됨.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Declared In

KOTalkMessageSending.h

– sendMemoWithURL:templateId:templateArgs:completionHandler:

지정된 URL을 스크랩하여, 카카오톡의 “나와의 채팅방"으로 메시지를 전송합니다. 모든 앱에서 호출 가능합니다.

- (KOSessionTask *)sendMemoWithURL:(NSURL *)URL templateId:(NSString *)templateId templateArgs:(NSDictionary<NSString*,id> *)templateArgs completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

URL

스크랩할 URL. 개발자사이트 앱 설정에 등록된 도메인만 허용됨.

templateId

전송할 메시지 템플릿 ID.

templateArgs

메시지 템플릿을 완성하기 위해 필요한 추가 파라미터 정보.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Declared In

KOTalkMessageSending.h

– sendMemoWithTemplateId:templateArgs:completionHandler:

미리 지정된 메시지 템플릿(V2)을 사용하여, 카카오톡의 “나와의 채팅방"으로 메시지를 전송합니다. 모든 앱에서 호출 가능합니다.

- (KOSessionTask *)sendMemoWithTemplateId:(NSString *)templateId templateArgs:(NSDictionary<NSString*,id> *)templateArgs completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

templateId

전송할 메시지 템플릿 ID.

templateArgs

메시지 템플릿을 완성하기 위해 필요한 추가 파라미터 정보.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Declared In

KOTalkMessageSending.h

– sendMessageWithTemplate:completionHandler:

기본 제공되는 템플릿을 이용하여, 카카오톡으로 메시지를 전송합니다. 제휴를 통해 권한이 부여된 특정 앱에서만 호출 가능합니다.

- (KOSessionTask *)sendMessageWithTemplate:(KMTTemplate *)templateObj completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

templateObj

전송할 메시지 템플릿 오브젝트. KMTTemplate 클래스를 직접 생성해서 사용할 수 없고 원하는 템플릿에 맞는 적절한 하위 클래스로 오브젝트를 생성해야 함.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Discussion

KMTTemplate 클래스는 KakaoMessageTemplate.framework에 포함되어 있습니다. 이 메소드를 사용하기 위해서는 Build Phases > Link Binary With Libraries 설정에 KakaoMessageTemplate.framework를 추가해야 합니다.

Declared In

KOTalkMessageSending.h

– sendMessageWithTemplateId:templateArgs:completionHandler:

미리 지정된 메시지 템플릿(V2)을 사용하여, 카카오톡으로 메시지를 전송합니다. 제휴를 통해 권한이 부여된 특정 앱에서만 호출 가능합니다.

- (KOSessionTask *)sendMessageWithTemplateId:(NSString *)templateId templateArgs:(NSDictionary<NSString*,id> *)templateArgs completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

templateId

전송할 메시지 템플릿 ID.

templateArgs

메시지 템플릿을 완성하기 위해 필요한 추가 파라미터 정보.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Declared In

KOTalkMessageSending.h

– sendMessageWithURL:completionHandler:

지정된 URL을 스크랩하여, 카카오톡으로 메시지를 전송합니다. 제휴를 통해 권한이 부여된 특정 앱에서만 호출 가능합니다.

- (KOSessionTask *)sendMessageWithURL:(NSURL *)URL completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

URL

스크랩할 URL. 개발자사이트 앱 설정에 등록된 도메인만 허용됨.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Declared In

KOTalkMessageSending.h

– sendMessageWithURL:templateId:templateArgs:completionHandler:

지정된 URL을 스크랩하여, 카카오톡으로 메시지를 전송합니다. 제휴를 통해 권한이 부여된 특정 앱에서만 호출 가능합니다.

- (KOSessionTask *)sendMessageWithURL:(NSURL *)URL templateId:(NSString *)templateId templateArgs:(NSDictionary<NSString*,id> *)templateArgs completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

URL

스크랩할 URL. 개발자사이트 앱 설정에 등록된 도메인만 허용됨.

templateId

전송할 메시지 템플릿 ID.

templateArgs

메시지 템플릿을 완성하기 위해 필요한 추가 파라미터 정보.

completionHandler

요청 완료시 실행될 block. 오류 처리와 전송 완료 시 수행된다.

Declared In

KOTalkMessageSending.h