class TalkApiClient
카카오 Open API 의 카카오톡 API 호출을 담당하는 클라이언트.
<init> |
카카오 Open API 의 카카오톡 API 호출을 담당하는 클라이언트. TalkApiClient(talkApi: TalkApi = ApiFactory.kapiWithOAuth.create(TalkApi::class.java), applicationInfo: ApplicationInfo = KakaoSdk.applicationContextInfo, contextInfo: ContextInfo = KakaoSdk.applicationContextInfo) |
addChannelUrl |
카카오톡 채널을 추가하기 위한 URL 을 반환합니다. URL 을 브라우저나 웹뷰에서 로드하면 브릿지 웹페이지를 통해 카카오톡을 실행합니다. fun addChannelUrl(channelPublicId: String): Uri |
channelChatUrl |
카카오톡 채널 1:1 대화방 실행을 위한 URL 을 반환합니다. URL 을 브라우저나 웹뷰에서 로드하면 브릿지 웹페이지를 통해 카카오톡을 실행합니다. fun channelChatUrl(channelPublicId: String): Uri |
channels |
사용자가 특정 카카오톡 채널을 추가했는지 확인합니다. fun channels(publicIds: String? = null, callback: (relations: ChannelRelations?, error: Throwable?) -> Unit): Unit |
friends |
카카오톡 친구 목록을 조회합니다. fun friends(secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null, callback: (friends: Friends<Friend>?, error: Throwable?) -> Unit): Unit |
profile |
로그인된 사용자의 카카오톡 프로필 정보를 얻을 수 있습니다. fun profile(secureResource: Boolean? = true, callback: (profile: TalkProfile?, error: Throwable?) -> Unit): Unit |
sendCustomMemo |
개발자사이트에서 생성한 서비스만의 커스텀 메시지 템플릿을 사용하여, 카카오톡의 나와의 채팅방으로 메시지를 전송합니다. 템플릿을 생성하는 방법은 https://developers.kakao.com/docs/template 을 참고하시기 바랍니다. fun sendCustomMemo(templateId: Long, templateArgs: Map<String, String>? = null, callback: (error: Throwable?) -> Unit): Unit |
sendCustomMessage |
개발자사이트에서 생성한 메시지 템플릿을 사용하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. 템플릿을 생성하는 방법은 https://developers.kakao.com/docs/template 을 참고하시기 바랍니다. fun sendCustomMessage(receiverUuids: List<String>, templateId: Long, templateArgs: Map<String, String>? = null, callback: (result: MessageSendResult?, error: Throwable?) -> Unit): Unit |
sendDefaultMemo |
기본 템플릿을 이용하여, 카카오톡의 나와의 채팅방으로 메시지를 전송합니다. fun sendDefaultMemo(template: DefaultTemplate, callback: (error: Throwable?) -> Unit): Unit |
sendDefaultMessage |
기본 템플릿을 사용하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. fun sendDefaultMessage(receiverUuids: List<String>, template: DefaultTemplate, callback: (result: MessageSendResult?, error: Throwable?) -> Unit): Unit |
sendScrapMemo |
지정된 URL 을 스크랩하여, 카카오톡의 나와의 채팅방으로 메시지를 전송합니다. fun sendScrapMemo(requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (error: Throwable?) -> Unit): Unit |
sendScrapMessage |
지정된 URL을 스크랩하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. 스크랩 커스텀 템플릿 가이드를 참고하여 템플릿을 직접 만들고 스크랩 메시지 전송에 이용할 수도 있습니다. fun sendScrapMessage(receiverUuids: List<String>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (result: MessageSendResult?, error: Throwable?) -> Unit): Unit |
instance |
간편한 API 호출을 위해 기본 제공되는 singleton 객체 val instance: TalkApiClient |
chatList |
카카오톡 채팅방 목록을 가져옵니다. fun TalkApiClient.chatList(filters: List<ChatFilter>? = null, offset: Int? = null, limit: Int? = null, order: Order? = null, secureResource: Boolean? = true, callback: (chats: Chats?, error: Throwable?) -> Unit): Unit |
chatMembers |
사용자의 카카오톡 채팅방에 속한 멤버를 조회합니다. 채팅방 아이디를 기준으로 조회하며 친구인 멤버만 조회할지 여부를 선택할 수 있습니다. fun TalkApiClient.chatMembers(chatId: Long, friendsOnly: Boolean? = null, includeProfile: Boolean? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null, callback: (chatMembers: ChatMembers?, error: Throwable?) -> Unit): Unit |
friendsForPartner |
사용자의 카카오 플랫폼 내 친구 목록을 가져옵니다. fun TalkApiClient.friendsForPartner(friendType: FriendType? = null, friendFilter: FriendFilter? = null, friendOrder: FriendOrder? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null, callback: (friends: Friends<PartnerFriend>?, error: Throwable?) -> Unit): Unit |
sendCustomMessageForPartner |
개발자사이트에서 생성한 메시지 템플릿을 사용하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. fun TalkApiClient.sendCustomMessageForPartner(receiverUuids: List<String>, templateId: Long, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit |
sendCustomMessageToChats |
개발자사이트에서 생성한 메시지 템플릿을 사용하여, 특정 채팅방에 카카오톡 메시지를 전송합니다. fun TalkApiClient.sendCustomMessageToChats(receiverChatIds: List<Long>, templateId: Long, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit |
sendDefaultMessageForPartner |
기본 템플릿을 사용하여, 특정 채팅방에 카카오톡 메시지를 전송합니다. fun TalkApiClient.sendDefaultMessageForPartner(receiverUuids: List<String>, template: DefaultTemplate, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit |
sendDefaultMessageToChats |
기본 템플릿을 사용하여, 특정 채팅방에 카카오톡 메시지를 전송합니다. fun TalkApiClient.sendDefaultMessageToChats(receiverChatIds: List<Long>, template: DefaultTemplate, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit |
sendScrapMessageForPartner |
지정된 URL을 스크랩하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. fun TalkApiClient.sendScrapMessageForPartner(receiverUuids: List<String>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit |
sendScrapMessageToChats |
지정된 URL 을 스크랩하여, 특정 채팅방에 카카오톡 메시지를 전송합니다. fun TalkApiClient.sendScrapMessageToChats(receiverChatIds: List<Long>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit |
rx |
Reactive-X 를 위한 TalkApiClient singleton 객체 val TalkApiClient.Companion.rx: RxTalkApiClient |