iOS Reference

KOSessionTask(TalkAPI)


Discussion

인증된 session 정보를 바탕으로 각종 카카오톡 API를 호출할 수 있습니다.

Extends Class

KOSessionTask

Declared In

KOSessionTask+TalkAPI.h


Methods

+talkChatListTaskWithContext:completionHandler:

카카오톡 채팅방 목록을 가져옵니다. 제휴를 통해 권한이 부여된 특정 앱에서만 호출 가능합니다.

+talkMembersTaskWithChatID:friendsOnly:completionHandler:

사용자의 채팅방에 속한 멤버 리스트 정보를 반환합니다.

+talkMemoSendTaskWithTemplate:completionHandler:

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

+talkMemoSendTaskWithTemplateId:templateArgs:completionHandler:

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

+talkMemoSendTaskWithURL:completionHandler:

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

+talkMemoSendTaskWithURL:templateId:templateArgs:completionHandler:

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

+talkMessageSendTaskWithTemplate:receiverType:receiverId:completionHandler:

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

+talkMessageSendTaskWithTemplateId:templateArgs:receiverType:receiverId:completionHandler:

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

+talkMessageSendTaskWithURL:receiverType:receiverId:completionHandler:

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

+talkMessageSendTaskWithURL:templateId:templateArgs:receiverType:receiverId:completionHandler:

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

+talkPlusFriendsTaskWithCompletionHandler:

사용자가 특정 카카오톡 채널을 추가했는지 확인합니다.

+talkPlusFriendsTaskWithPublicIds:completionHandler:

사용자가 특정 카카오톡 채널을 추가했는지 확인합니다.

+talkProfileTaskWithCompletionHandler:

현재 로그인된 사용자의 카카오톡 프로필 정보를 얻을 수 있습니다.

+talkProfileTaskWithSecureResource:completionHandler:

현재 로그인된 사용자의 카카오톡 프로필 정보를 얻을 수 있습니다.


talkChatListTaskWithContext:completionHandler:


카카오톡 채팅방 목록을 가져옵니다. 제휴를 통해 권한이 부여된 특정 앱에서만 호출 가능합니다.

+ (nullable instancetype)talkChatListTaskWithContext:(KOChatContext *)context completionHandler:(nullable void (^)(NSArray<KOChat *> *_Nullable chats, NSError *_Nullable error))completionHandler; 
Parameters
context

채팅방 목록을 불러올 때, 페이징 정보를 처리하기 위한 context.

completionHandler

카카오톡 채팅방 목록을 가져와서 처리하는 핸들러.


talkMembersTaskWithChatID:friendsOnly:completionHandler:


사용자의 채팅방에 속한 멤버 리스트 정보를 반환합니다.

+ (instancetype)talkMembersTaskWithChatID:(id)chatID friendsOnly:(BOOL)friendsOnly completionHandler:(nullable KOSessionTaskTalkMembersCompletionHandler)completionHandler; 
Parameters
chatID

talkChatListTaskWithContext:completionHandler: 메소드로 받아온 채팅방의 아이디

friendsOnly

채팅 멤버 중 친구인 멤버만 가져오고 싶을 경우 YES로 설정

completionHandler

채팅 멤버 목록 완료 핸들러. 친구만 가져올 경우 activeMember와 activeFriends


talkMemoSendTaskWithTemplate:completionHandler:


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

+ (nullable instancetype)talkMemoSendTaskWithTemplate:(KMTTemplate *)templateObj completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
templateObj

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

completionHandler

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

Discussion

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


talkMemoSendTaskWithTemplateId:templateArgs:completionHandler:


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

+ (nullable instancetype)talkMemoSendTaskWithTemplateId:(NSString *)templateId templateArgs:(nullable NSDictionary<NSString *, NSString *> *)templateArgs completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
templateId

전송할 메시지 템플릿 ID.

templateArgs

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

completionHandler

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


talkMemoSendTaskWithURL:completionHandler:


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

+ (nullable instancetype)talkMemoSendTaskWithURL:(NSURL *)URL completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
URL

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

completionHandler

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


talkMemoSendTaskWithURL:templateId:templateArgs:completionHandler:


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

+ (nullable instancetype)talkMemoSendTaskWithURL:(NSURL *)URL templateId:(nullable NSString *)templateId templateArgs:(nullable NSDictionary<NSString *, NSString *> *)templateArgs completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
URL

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

templateId

전송할 메시지 템플릿 ID.

templateArgs

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

completionHandler

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


talkMessageSendTaskWithTemplate:receiverType:receiverId:completionHandler:


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

+ (nullable instancetype)talkMessageSendTaskWithTemplate:(KMTTemplate *)templateObj receiverType:(KOTalkMessageReceiverIDType)receiverType receiverId:(id)receiverId completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
templateObj

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

receiverType

메시지 수신 대상 ID의 타입.

receiverId

메시지를 수신할 대상(채팅방 또는 사용자)의 ID.

completionHandler

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

Discussion

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


talkMessageSendTaskWithTemplateId:templateArgs:receiverType:receiverId:completionHandler:


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

+ (nullable instancetype)talkMessageSendTaskWithTemplateId:(NSString *)templateId templateArgs:(nullable NSDictionary<NSString *, NSString *> *)templateArgs receiverType:(KOTalkMessageReceiverIDType)receiverType receiverId:(id)receiverId completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
templateId

전송할 메시지 템플릿 ID.

templateArgs

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

receiverType

메시지 수신 대상 ID의 타입.

receiverId

메시지를 수신할 대상(채팅방 또는 사용자)의 ID.

completionHandler

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


talkMessageSendTaskWithURL:receiverType:receiverId:completionHandler:


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

+ (nullable instancetype)talkMessageSendTaskWithURL:(NSURL *)URL receiverType:(KOTalkMessageReceiverIDType)receiverType receiverId:(id)receiverId completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
URL

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

receiverType

메시지 수신 대상 ID의 타입.

receiverId

메시지를 수신할 대상(채팅방 또는 사용자)의 ID.

completionHandler

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


talkMessageSendTaskWithURL:templateId:templateArgs:receiverType:receiverId:completionHandler:


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

+ (nullable instancetype)talkMessageSendTaskWithURL:(NSURL *)URL templateId:(nullable NSString *)templateId templateArgs:(nullable NSDictionary<NSString *, NSString *> *)templateArgs receiverType:(KOTalkMessageReceiverIDType)receiverType receiverId:(id)receiverId completionHandler:(nullable void (^)(NSError *_Nullable error))completionHandler; 
Parameters
URL

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

templateId

전송할 메시지 템플릿 ID.

templateArgs

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

receiverType

메시지 수신 대상 ID의 타입.

receiverId

메시지를 수신할 대상(채팅방 또는 사용자)의 ID.

completionHandler

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


talkPlusFriendsTaskWithCompletionHandler:


사용자가 특정 카카오톡 채널을 추가했는지 확인합니다.

+ (instancetype)talkPlusFriendsTaskWithCompletionHandler:(nullable KOSessionTaskTalkPlusFriendsCompletionHandler)completionHandler; 
Parameters
completionHandler

해당 사용자의 채널 추가상태 조회 완료 핸들러. KOTalkPlusFriends 객체를 리턴한다.

See Also


talkPlusFriendsTaskWithPublicIds:completionHandler:


사용자가 특정 카카오톡 채널을 추가했는지 확인합니다.

+ (instancetype)talkPlusFriendsTaskWithPublicIds:(nullable NSArray<NSString *> *)publicIds 
        completionHandler:(nullable KOSessionTaskTalkPlusFriendsCompletionHandler)completionHandler; 
Parameters
publicIds

조회하려는 채널의 public Id 목록

completionHandler

해당 사용자의 채널 추가상태 조회 완료 핸들러. KOTalkPlusFriends 객체를 리턴한다.

See Also


talkProfileTaskWithCompletionHandler:


현재 로그인된 사용자의 카카오톡 프로필 정보를 얻을 수 있습니다.

+ (instancetype)talkProfileTaskWithCompletionHandler:(nullable KOSessionTaskCompletionHandler)completionHandler; 
Parameters
completionHandler

카카오톡 프로필 정보를 얻어 처리하는 핸들러


talkProfileTaskWithSecureResource:completionHandler:


현재 로그인된 사용자의 카카오톡 프로필 정보를 얻을 수 있습니다.

+ (instancetype)talkProfileTaskWithSecureResource:(BOOL)secureResource completionHandler:(nullable KOSessionTaskCompletionHandler)completionHandler; 
Parameters
secureResource

프로필, 썸네일 이미지 등의 리소스 정보들에 대해 https를 지원하는 형식으로 응답을 받을지의 여부. YES일 경우 https지원, NO일 경우 http지원.

completionHandler

카카오톡 프로필 정보를 얻어 처리하는 핸들러